Deduplicate the nav specification with literate-nav

docs/dev-guide/README.md

@@ -11,6 +11,8 @@ below, or use the *next* and *previous* buttons in the navigation bar at the
 top of the page to move through the documentation in order.
 
 - [Themes](themes.md)
+- [Translations](translations.md)
 - [Plugins](plugins.md)
+- [API Reference](api.md)
 
 [Contributing Guide]: ../about/contributing.md

docs/getting-started.md

@@ -218,4 +218,4 @@ To get help with MkDocs, please use the [GitHub discussions] or [GitHub issues].
 [site_name]: user-guide/configuration.md#site_name
 [site_url]: user-guide/configuration.md#site_url
 [theme]: user-guide/configuration.md#theme
-[User Guide]: user-guide/index.md
+[User Guide]: user-guide/README.md

docs/index.md

@@ -11,7 +11,7 @@ configuration file. Start by reading the [introductory tutorial], then check the
 [User Guide] for more information.
 
 [introductory tutorial]: getting-started.md
-[User Guide]: user-guide/index.md
+[User Guide]: user-guide/README.md
 
 <div class="text-center">
 <a href="getting-started/" class="btn btn-primary" role="button">Getting Started</a>

docs/user-guide/README.md

@@ -13,6 +13,7 @@ bar at the top of the page to move through the documentation in order.
 - [Writing Your Docs](writing-your-docs.md)
 - [Choosing Your Theme](choosing-your-theme.md)
 - [Customizing Your Theme](customizing-your-theme.md)
+- [Localizing Your Theme](localizing-your-theme.md)
 - [Configuration](configuration.md)
 - [Deploying Your Docs](deploying-your-docs.md)
 

mkdocs.yml

@@ -18,21 +18,8 @@ theme:
 nav:
     - Home: index.md
     - Getting Started: getting-started.md
-    - User Guide:
-        - Overview: user-guide/index.md
-        - Installation: user-guide/installation.md
-        - Writing Your Docs: user-guide/writing-your-docs.md
-        - Choosing Your Theme: user-guide/choosing-your-theme.md
-        - Customizing Your Theme: user-guide/customizing-your-theme.md
-        - Localizing Your Theme: user-guide/localizing-your-theme.md
-        - Configuration: user-guide/configuration.md
-        - Deploying Your Docs: user-guide/deploying-your-docs.md
-    - Developer Guide:
-        - Overview: dev-guide/index.md
-        - Themes: dev-guide/themes.md
-        - Translations: dev-guide/translations.md
-        - Plugins: dev-guide/plugins.md
-        - API Reference: dev-guide/api.md
+    - User Guide: user-guide/
+    - Developer Guide: dev-guide/
     - About:
         - Release Notes: about/release-notes.md
         - Contributing: about/contributing.md
@@ -62,6 +49,9 @@ plugins:
             user-guide/custom-themes.md: dev-guide/themes.md
             user-guide/styling-your-docs.md: user-guide/choosing-your-theme.md
     - autorefs
+    - literate-nav:
+        nav_file: README.md
+        implicit_index: true
     - mkdocstrings:
         handlers:
           python:

requirements/project-min.txt

@@ -15,6 +15,7 @@ babel==2.9.0
 colorama==0.4; platform_system == 'Windows'
 mdx_gh_links==0.2
 markdown-callouts==0.2
+mkdocs-literate-nav==0.5.0
 mkdocs-redirects==1.0.1
 pymdown-extensions==8.0.1
 mkdocstrings-python==0.7.1

requirements/project.txt

@@ -15,6 +15,7 @@ babel>=2.9.0
 colorama>=0.4; platform_system == 'Windows'
 mdx_gh_links>=0.2
 markdown-callouts>=0.2
+mkdocs-literate-nav>=0.5.0
 mkdocs-redirects>=1.0.1
 pymdown-extensions>=8.0.1
 mkdocstrings-python>=0.7.1