Resolve relative path issues, update tooling.

Author: kattni

docs/en/how-to/contribute/how/build-docs.md

@@ -4,12 +4,12 @@
 
 {% block front_matter %}
 
-Before you build the documentation, and have a [development environment](dev-environment.md) set up.
+Before you build the documentation, and have a [development environment](../how/dev-environment.md) set up.
 
 {% endblock %}
 
 {% block end_matter %}
 
-Once you have successfully built the docs, you are ready to [write documentation](write-docs.md).
+Once you have successfully built the docs, you are ready to [write documentation](../how/write-docs.md).
 
 {% endblock %}

docs/en/how-to/contribute/how/reproduce-issue.md

@@ -4,7 +4,7 @@
 
 {% block front_matter %}
 
-To begin reproducing an issue, you will need a [development environment](dev-environment.md) set up.
+To begin reproducing an issue, you will need a [development environment](../how/dev-environment.md) set up.
 
 {% endblock %}
 

docs/en/how-to/contribute/how/submit-pr.md

@@ -6,11 +6,11 @@
 
 {% if config.extra.website %}
 
-Your pull request may require additional content, such as a [change note](change-note.md), before it can be [reviewed](../next/pr-review.md).
+Your pull request may require additional content, such as a [change note](../how/change-note.md), before it can be [reviewed](../next/pr-review.md).
 
 {% else %}
 
-As part of submitting a pull request, you'll need to include a [change note](change-note.md) before it can be [reviewed](../next/pr-review.md).
+As part of submitting a pull request, you'll need to include a [change note](../how/change-note.md) before it can be [reviewed](../next/pr-review.md).
 
 {% endif %}
 

docs/en/how-to/contribute/how/write-code.md

@@ -4,12 +4,12 @@
 
 {% block front_matter %}
 
-To begin working on code, ensure you have a [development environment](dev-environment.md) set up, and you are [working on a branch](branches.md)
+To begin working on code, ensure you have a [development environment](../how/dev-environment.md) set up, and you are [working on a branch](../how/branches.md)
 
 {% endblock %}
 
 {% block end_matter %}
 
-Once you have everything working, you can [submit a pull request](submit-pr.md) with your changes.
+Once you have everything working, you can [submit a pull request](../how/submit-pr.md) with your changes.
 
 {% endblock %}

docs/en/how-to/contribute/how/write-docs.md

@@ -4,12 +4,12 @@
 
 {% block front_matter %}
 
-Before you begin writing documentation, ensure you are able to [build the documentation](build-docs.md), and you are [working on a branch](branches.md).
+Before you begin writing documentation, ensure you are able to [build the documentation](../how/build-docs.md), and you are [working on a branch](../how/branches.md).
 
 {% endblock %}
 
 {% block end_matter %}
 
-Once you are happy with your new documentation, you can [submit a pull request](submit-pr.md) with your proposed changes.
+Once you are happy with your new documentation, you can [submit a pull request](../how/submit-pr.md) with your proposed changes.
 
 {% endblock %}

pyproject.toml

@@ -29,8 +29,7 @@ dependencies = [
     "mistletoe==1.5.1",
     "mkdocs-autorefs==1.4.4",
     "mkdocs-literate-nav==0.6.3",  # DO NOT UPGRADE - Uncertain whether author's move to ProperDocs will cause incompatibility
-    "mkdocs-macros-plugin @ file:///Users/kattni/BeeWare/mkdocs-macros-plugin",
-#    "mkdocs-macros-plugin",
+    "mkdocs-macros-plugin @ git+https://github.com/kattni/mkdocs-macros-plugin@include-dir-multiple-directories",
     "mkdocs-material==9.7.6",
     "mkdocs-rss-plugin==1.19.0",
     "mkdocs==1.6.1",  # DO NOT UPGRADE - 2+ is not compatible with anything here

src/beeware_docs_tools/live_serve_en.py

@@ -66,7 +66,6 @@ def serve_docs(
         "mkdocs",
         "serve",
         "--clean",
-        # "--livereload",
         "--config-file",
         str(output_path / "mkdocs.en.yml"),
         "--watch",

src/beeware_docs_tools/md_tempdir.py

@@ -70,19 +70,17 @@ def save_config(project_path, temp_md_path, config, language="en"):
 
     if language != "en":
         shared_content_path = temp_md_path.resolve() / f"shared_content/{language}"
-        local_docs_path = temp_md_path.resolve() / f"docs/{language}"
+        local_docs_path = temp_md_path.resolve() / f"{language}"
     else:
         shared_content_path = (Path(__file__).parent / "shared_content/en").resolve()
         local_docs_path = (project_path / "docs/en").resolve()
 
     base_path.append(str(shared_content_path))
     config["markdown_extensions"]["pymdownx.snippets"]["base_path"] = base_path
-    print(config["plugins"]["macros"]["include_dir"])
     config["plugins"]["macros"]["include_dir"] = [
         str(shared_content_path),
         str(local_docs_path),
     ]
-    print(config["plugins"]["macros"]["include_dir"])
 
     with (temp_md_path / "config.yml").open("w", encoding="utf-8") as config_f:
         yaml.dump(config, config_f)

src/beeware_docs_tools/shared_content/en/contribute/what/fix-issue.md

@@ -18,48 +18,48 @@ Even if you can't fix the problem, reporting anything you discover during the pr
 
 /// details-abstract | Work from a branch
 
-{% include "contribute/how/branches.md" %}
+{% include "how-to/contribute/how/branches.md" %}
 
 ///
 
 /// details-abstract | Reproduce the issue
 
-{% include "contribute/how/reproduce-issue.md" %}
+{% include "how-to/contribute/how/reproduce-issue.md" %}
 
 ///
 
 **If fixing the issue requires changes to code:**
 
 /// details-abstract | Write, run, and test code
 
-{% include "contribute/how/write-code.md" %}
+{% include "how-to/contribute/how/write-code.md" %}
 
 ///
 
 **If fixing the issue requires changes to documentation:**
 
 /// details-abstract | Build documentation
 
-{% include "contribute/how/build-docs.md" %}
+{% include "how-to/contribute/how/build-docs.md" %}
 
 ///
 
 /// details-abstract | Write documentation
 
-{% include "contribute/how/write-docs.md" %}
+{% include "how-to/contribute/how/write-docs.md" %}
 
 ///
 
 **When you're ready to submit your contribution:**
 
 /// details-abstract | Add a change note
 
-{% include "contribute/how/change-note.md" %}
+{% include "how-to/contribute/how/change-note.md" %}
 
 ///
 
 /// details-abstract | Submit a pull request
 
-{% include "contribute/how/submit-pr.md" %}
+{% include "how-to/contribute/how/submit-pr.md" %}
 
 ///

src/beeware_docs_tools/shared_content/en/contribute/what/implement-feature.md

@@ -15,48 +15,48 @@ An important part of implementing a new feature is ensuring that feature is full
 
 /// details-abstract | Set up a development environment
 
-{% include "contribute/how/dev-environment.md" %}
+{% include "how-to/contribute/how/dev-environment.md" %}
 
 ///
 
 /// details-abstract | Work from a branch
 
-{% include "contribute/how/branches.md" %}
+{% include "how-to/contribute/how/branches.md" %}
 
 ///
 
 /// details-abstract | Avoid scope creep
 
-{% include "contribute/how/scope-creep.md" %}
+{% include "how-to/contribute/how/scope-creep.md" %}
 
 ///
 
 /// details-abstract | Implement the new feature
 
-{% include "contribute/how/write-code.md" %}
+{% include "how-to/contribute/how/write-code.md" %}
 
 ///
 
 /// details-abstract | Build documentation
 
-{% include "contribute/how/build-docs.md" %}
+{% include "how-to/contribute/how/build-docs.md" %}
 
 ///
 
 /// details-abstract | Write documentation
 
-{% include "contribute/how/write-docs.md" %}
+{% include "how-to/contribute/how/write-docs.md" %}
 
 ///
 
 /// details-abstract | Add a change note
 
-{% include "contribute/how/change-note.md" %}
+{% include "how-to/contribute/how/change-note.md" %}
 
 ///
 
 /// details-abstract | Submit a pull request
 
-{% include "contribute/how/submit-pr.md" %}
+{% include "how-to/contribute/how/submit-pr.md" %}
 
 ///