From 691ecb1f5b37fe85f50572940e4e7ea61fb580b8 Mon Sep 17 00:00:00 2001 From: psychedelicious <4822129+psychedelicious@users.noreply.github.com> Date: Thu, 29 Feb 2024 23:02:27 +1100 Subject: [PATCH] docs: update mkdocs config --- docs/stylesheets/extra.css | 5 -- mkdocs.yml | 101 +++++++++++++++++++------------------ 2 files changed, 52 insertions(+), 54 deletions(-) delete mode 100644 docs/stylesheets/extra.css diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css deleted file mode 100644 index 42a2cfe74a..0000000000 --- a/docs/stylesheets/extra.css +++ /dev/null @@ -1,5 +0,0 @@ -:root { - --md-primary-fg-color: #35A4DB; - --md-primary-fg-color--light: #35A4DB; - --md-primary-fg-color--dark: #35A4DB; - } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index bdd429fb93..f1239dc318 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ edit_uri: edit/main/docs/ copyright: Copyright © 2023 InvokeAI Team extra_css: - - stylesheets/extra.css + - stylesheets/extra.css # Configuration theme: @@ -25,18 +25,7 @@ theme: edit: material/file-document-edit-outline favicon: img/favicon.ico palette: - # - media: '(prefers-color-scheme: light)' - # scheme: default - # primary: custom - # toggle: - # icon: material/lightbulb - # name: Switch to dark mode - - media: '(prefers-color-scheme: dark)' - scheme: slate - primary: custom - # toggle: - # icon: material/lightbulb-outline - # name: Switch to light mode + scheme: slate features: - navigation.instant - navigation.tabs @@ -48,7 +37,6 @@ theme: - search.suggest - toc.integrate - # Extensions markdown_extensions: - abbr @@ -66,8 +54,8 @@ markdown_extensions: - pymdownx.caret - pymdownx.details - pymdownx.emoji: - emoji_index: !!python/name:materialx.emoji.twemoji - emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite @@ -97,12 +85,25 @@ plugins: enable_creation_date: true - redirects: redirect_maps: - 'installation/INSTALL_AUTOMATED.md': 'installation/010_INSTALL_AUTOMATED.md' - 'installation/INSTALL_MANUAL.md': 'installation/020_INSTALL_MANUAL.md' - 'installation/INSTALL_SOURCE.md': 'installation/020_INSTALL_MANUAL.md' - 'installation/INSTALL_DOCKER.md': 'installation/040_INSTALL_DOCKER.md' - 'installation/INSTALLING_MODELS.md': 'installation/050_INSTALLING_MODELS.md' - 'installation/INSTALL_PATCHMATCH.md': 'installation/060_INSTALL_PATCHMATCH.md' + 'installation/INSTALL_AUTOMATED.md': 'installation/010_INSTALL_AUTOMATED.md' + 'installation/INSTALL_MANUAL.md': 'installation/020_INSTALL_MANUAL.md' + 'installation/INSTALL_SOURCE.md': 'installation/020_INSTALL_MANUAL.md' + 'installation/INSTALL_DOCKER.md': 'installation/040_INSTALL_DOCKER.md' + 'installation/INSTALLING_MODELS.md': 'installation/050_INSTALLING_MODELS.md' + 'installation/INSTALL_PATCHMATCH.md': 'installation/060_INSTALL_PATCHMATCH.md' + - mkdocstrings: + handlers: + python: + options: + separate_signature: true + show_signature_annotations: true + parameter_headings: false + signature_crossrefs: true + show_source: false + summary: true + show_root_heading: true + show_root_full_path: false + show_bases: false extra_javascript: - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js @@ -115,8 +116,8 @@ extra: property: G-2X4JR4S4FB nav: - - Home: 'index.md' - - Installation: + - Home: 'index.md' + - Installation: - Overview: 'installation/INSTALLATION.md' - Installing with the Automated Installer: 'installation/010_INSTALL_AUTOMATED.md' - Installing Manually: 'installation/020_INSTALL_MANUAL.md' @@ -127,14 +128,14 @@ nav: - Installing xFormers: 'installation/070_INSTALL_XFORMERS.md' - Developers Documentation: 'installation/Developers_documentation/BUILDING_BINARY_INSTALLERS.md' - Deprecated Documentation: - - Binary Installer: 'installation/deprecated_documentation/INSTALL_BINARY.md' - - Runninng InvokeAI on Google Colab: 'installation/deprecated_documentation/INSTALL_JUPYTER.md' - - Manual Installation on Linux: 'installation/deprecated_documentation/INSTALL_LINUX.md' - - Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_MAC.md' - - Manual Installation on Windows: 'installation/deprecated_documentation/INSTALL_WINDOWS.md' - - Installing Invoke with pip: 'installation/deprecated_documentation/INSTALL_PCP.md' - - Source Installer: 'installation/deprecated_documentation/INSTALL_SOURCE.md' - - Workflows & Nodes: + - Binary Installer: 'installation/deprecated_documentation/INSTALL_BINARY.md' + - Runninng InvokeAI on Google Colab: 'installation/deprecated_documentation/INSTALL_JUPYTER.md' + - Manual Installation on Linux: 'installation/deprecated_documentation/INSTALL_LINUX.md' + - Manual Installation on macOS: 'installation/deprecated_documentation/INSTALL_MAC.md' + - Manual Installation on Windows: 'installation/deprecated_documentation/INSTALL_WINDOWS.md' + - Installing Invoke with pip: 'installation/deprecated_documentation/INSTALL_PCP.md' + - Source Installer: 'installation/deprecated_documentation/INSTALL_SOURCE.md' + - Workflows & Nodes: - Nodes Overview: 'nodes/overview.md' - Workflow Editor Basics: 'nodes/NODES.md' - List of Default Nodes: 'nodes/defaultNodes.md' @@ -142,8 +143,10 @@ nav: - ComfyUI to InvokeAI: 'nodes/comfyToInvoke.md' - Facetool Node: 'nodes/detailedNodes/faceTools.md' - Contributing Nodes: 'nodes/contributingNodes.md' - - Community Nodes: 'nodes/communityNodes.md' - - Features: + - Migrating from v3 to v4: 'nodes/NODES_MIGRATION_V3_V4.md' + - Invocation API: 'nodes/INVOCATION_API.md' + - Community Nodes: 'nodes/communityNodes.md' + - Features: - Overview: 'features/index.md' - New to InvokeAI?: 'help/gettingStartedWithAI.md' - Configuration: 'features/CONFIGURATION.md' @@ -152,35 +155,35 @@ nav: - Controlling Logging: 'features/LOGGING.md' - LoRAs & LCM-LoRAs: 'features/LORAS.md' - Model Merging: 'features/MODEL_MERGING.md' - - Workflows & Nodes : 'nodes/overview' + - Workflows & Nodes: 'nodes/overview' - NSFW Checker: 'features/WATERMARK+NSFW.md' - Postprocessing: 'features/POSTPROCESS.md' - Prompting Features: 'features/PROMPTS.md' - Textual Inversions: - - Textual Inversions: 'features/TEXTUAL_INVERSIONS.md' - - Textual Inversion Training: 'features/TRAINING.md' + - Textual Inversions: 'features/TEXTUAL_INVERSIONS.md' + - Textual Inversion Training: 'features/TRAINING.md' - Unified Canvas: 'features/UNIFIED_CANVAS.md' - InvokeAI Web Server: 'features/WEB.md' - - WebUI Hotkeys: "features/WEBUIHOTKEYS.md" - - Maintenance Utilities: "features/UTILITIES.md" + - WebUI Hotkeys: 'features/WEBUIHOTKEYS.md' + - Maintenance Utilities: 'features/UTILITIES.md' - Other: 'features/OTHER.md' - - Contributing: + - Contributing: - How to Contribute: 'contributing/CONTRIBUTING.md' - InvokeAI Code of Conduct: 'CODE_OF_CONDUCT.md' - Development: - - Overview: 'contributing/contribution_guides/development.md' - - New Contributors: 'contributing/contribution_guides/newContributorChecklist.md' - - Model Manager v2: 'contributing/MODEL_MANAGER.md' - - Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md' - - Local Development: 'contributing/LOCAL_DEVELOPMENT.md' - - Testing: 'contributing/TESTS.md' + - Overview: 'contributing/contribution_guides/development.md' + - New Contributors: 'contributing/contribution_guides/newContributorChecklist.md' + - Model Manager v2: 'contributing/MODEL_MANAGER.md' + - Frontend Documentation: 'contributing/contribution_guides/contributingToFrontend.md' + - Local Development: 'contributing/LOCAL_DEVELOPMENT.md' + - Testing: 'contributing/TESTS.md' - Documentation: 'contributing/contribution_guides/documentation.md' - Nodes: 'contributing/INVOCATIONS.md' - Model Manager: 'contributing/MODEL_MANAGER.md' - Download Queue: 'contributing/DOWNLOAD_QUEUE.md' - Translation: 'contributing/contribution_guides/translation.md' - Tutorials: 'contributing/contribution_guides/tutorials.md' - - Deprecated: + - Deprecated: - InvokeAI 2.3: 'deprecated/2to3.md' - Command Line Interface: 'deprecated/CLI.md' - Changelog: 'CHANGELOG.md' @@ -190,11 +193,11 @@ nav: - Inpainting: 'deprecated/INPAINTING.md' - Outpainting: 'deprecated/OUTPAINTING.md' - Troubleshooting: 'help/deprecated/TROUBLESHOOT.md' - - Help: + - Help: - Getting Started: 'help/gettingStartedWithAI.md' - FAQs: 'help/FAQ.md' - Diffusion Overview: 'help/diffusion.md' - Sampler Convergence: 'help/SAMPLER_CONVERGENCE.md' - - Other: + - Other: - Contributors: 'other/CONTRIBUTORS.md' - CompViz-README: 'other/README-CompViz.md'