From 831c390e95703ada45da15d80d6e4917f0615fd7 Mon Sep 17 00:00:00 2001 From: ketan Date: Fri, 21 Jun 2024 11:56:31 +0530 Subject: [PATCH] Add mkdocs.yml file --- docs/mkdocs.yml | 216 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 216 insertions(+) create mode 100644 docs/mkdocs.yml diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..508c3ff --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,216 @@ +site_name: Project Name +site_description: "Project technical and user documentation." +site_author: "Kartoza" +docs_dir: ./src +site_dir: ./site +repo_name: "Project Name" +repo_url: "https://github.com/kartoza/" +edit_uri: "https://github.com/kartoza//blob/main/docs/" + +copyright: Kartoza and Contributors + +markdown_extensions: + - attr_list # lets us resize images see https://github.com/mkdocs/mkdocs/issues/1678#issuecomment-455500757 + - sane_lists # needed to keep numbers in ordered lists correct + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + #- mdx_truly_sane_lists + - toc: + permalink: true + #slugify: !!python/name:pymdownx.slugs.slugify + - pymdownx.snippets: + base_path: . + - admonition + - tables + - pymdownx.details + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.emoji: + emoji_generator: !!python/name:materialx.emoji.to_svg + emoji_index: !!python/name:materialx.emoji.twemoji + +# Navigation +nav: + - Home: + - Home: index.md + - Code of Conduct: about/code-of-conduct.md + - License: about/license.md + - Running Instances: about/running-instances.md + - User: + - user/index.md + - Quickstart: user/quickstart/index.md + - Guide: + - user/guide/index.md + - Manual : + - user/manual/index.md + - Administrators: + - administrator/index.md + - Guide: + - administrator/guide/index.md + - Manual: + - administrator/manual/index.md + - Developers: + - developer/index.md + - Guide: + - developer/guide/index.md + - Architecture: developer/guide/architecture.md + - Prerequisites: developer/guide/prerequisites.md + - Cloning: developer/guide/cloning.md + - IDE Setup: developer/guide/ide-setup.md + - Configuration: developer/guide/configuration.md + - Building: developer/guide/building.md + - Design: developer/guide/design.md + - Road Map: developer/guide/roadmap.md + - Workflows: developer/guide/workflows.md + # Pages to render but exclude from navigation + - "": developer/guide/templates/pull-request-template.md + - "": developer/guide/templates/commit-message-convention.md + - Manual: developer/manual/index.md + - Documentation Writing: + - developer/documentation/index.md + - Simple Workflow: developer/documentation/easy-workflow.md + - Advanced Workflow: developer/documentation/overview.md + - Context Help: developer/documentation/context-help.md + - API: + - developer/api/index.md + - Reference: developer/api/manual/index.md + - Guide: developer/api/guide/index.md + - License: about/license.md + - DevOps: + - devops/index.md + - Guide: devops/guide/index.md + - Manual: devops/manual/index.md + - About: + - About: about/index.md + - License: about/license.md + - Contributing: about/contributing.md + - Disclaimer: about/disclaimer.md + + +# Configuration +theme: + name: material + language: en + direction: ltr + include_search_page: false + search_index_only: true + features: + - content.code.annotate + - content.tabs.link + - header.autohide +# - navigation.expand # This causes the nav menu to auto expand + - navigation.indexes + - navigation.instant +# - navigation.sections # This removes the ability to shrink sections on the nav menu but gives the bold headings + - navigation.tabs + - navigation.tabs.sticky + - navigation.top + - navigation.tracking + - search.highlight + - search.share + - search.suggest + - toc.follow + palette: + - scheme: default + primary: blue + accent: grey + toggle: + icon: material/brightness-4 + name: Switch to dark mode + - scheme: slate + primary: blue + accent: grey + toggle: + icon: material/brightness-6 + name: Switch to light mode + font: + text: Roboto + code: Roboto Mono + favicon: assets/logo.png + icon: + logo: material/book + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/kartoza + - icon: fontawesome/brands/docker + link: https://hub.docker.com/r/kartoza/ + - icon: fontawesome/brands/twitter + link: https://twitter.com/KartozaGeo + - icon: fontawesome/brands/facebook + link: https://kartoza.com + - icon: fontawesome/solid/earth-africa + link: https://kartoza.com + +extra_css: + - css/print.css + +extra_javascript: + - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js + - js/tablesort.js + +# Needed for the hooks below to work +plugins: + - search + - mkdocs-video + - mkdocstrings: + handlers: + python: + paths: [../django_project] + import: + - https://docs.python.org/3/objects.inv + - https://mkdocstrings.github.io/autorefs/objects.inv + options: + # Lots of other nice options can be found at + # https://mkdocstrings.github.io/python/usage/ + docstring_style: sphinx + heading_level: 2 + show_bases: true + show_signature: true + separate_signature: true + show_signature_annotations: true + show_source: true + show_root_heading: true + show_root_full_path: true + show_root_members_full_path: true + merge_init_into_class: true + docstring_options: + ignore_init_summary: false + + - redirects: + redirect_maps: + #see https://github.com/mkdocs/mkdocs-redirects/tree/master#using + #'old.md': 'new.md' + #'old/file.md': 'new/file.md' + #'some_file.md': 'http://external.url.com/foobar' + - enumerate-headings: + toc_depth: 3 + strict: true + increment_across_pages: true + include: + - "*" + exclude: + - index.md + - user/index.md + - administrator/index.md + - developer/index.md + - developer/manual/*.md + - devops/index.md + restart_increment_after: + - second_section.md + +# Hook to add a uuid to every anchor +# see also hook.py and https://github.com/squidfunk/mkdocs-material/discussions/3758#discussioncomment-4397373 +# Note that although the above link implies you can use UUIDs, you have to use numeric IDS not UUIDS +hooks: + - ./uuid_redirects_hook.py + - ./python_manual_hook.py