Merge pull request #167 from callowayproject/refactor-docs

Refactored the docs
callowayproject · Mar 27, 2024 · d66d34e · d66d34e
2 parents 4a8fc13 + 2aa1011
commit d66d34e
Show file tree

Hide file tree

Showing 37 changed files with 15 additions and 16 deletions.
diff --git a/docsrc/CHANGELOG.md → docs/CHANGELOG.md b/docsrc/CHANGELOG.md → docs/CHANGELOG.md
diff --git a/docsrc/CONTRIBUTING.md → docs/CONTRIBUTING.md b/docsrc/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/docsrc/LICENSE → docs/LICENSE b/docsrc/LICENSE → docs/LICENSE
diff --git a/docsrc/_static/bump-my-version-logo.svg → docs/assets/bump-my-version-logo.svg b/docsrc/_static/bump-my-version-logo.svg → docs/assets/bump-my-version-logo.svg
diff --git a/docsrc/_static/bump-my-version-model.drawio → docs/assets/bump-my-version-model.drawio b/docsrc/_static/bump-my-version-model.drawio → docs/assets/bump-my-version-model.drawio
diff --git a/docsrc/_static/creating-a-version-spec.svg → docs/assets/creating-a-version-spec.svg b/docsrc/_static/creating-a-version-spec.svg → docs/assets/creating-a-version-spec.svg
diff --git a/docsrc/_static/creating-a-version.svg → docs/assets/creating-a-version.svg b/docsrc/_static/creating-a-version.svg → docs/assets/creating-a-version.svg
diff --git a/docsrc/_static/css/cards.css → docs/assets/css/cards.css b/docsrc/_static/css/cards.css → docs/assets/css/cards.css
diff --git a/docsrc/_static/css/custom.css → docs/assets/css/custom.css b/docsrc/_static/css/custom.css → docs/assets/css/custom.css
diff --git a/docsrc/_static/css/field-list.css → docs/assets/css/field-list.css b/docsrc/_static/css/field-list.css → docs/assets/css/field-list.css
diff --git a/docsrc/_static/css/mkdocstrings.css → docs/assets/css/mkdocstrings.css b/docsrc/_static/css/mkdocstrings.css → docs/assets/css/mkdocstrings.css
diff --git a/...c/_static/serializing-a-version-1-0-0.svg → docs/assets/serializing-a-version-1-0-0.svg b/...c/_static/serializing-a-version-1-0-0.svg → docs/assets/serializing-a-version-1-0-0.svg
diff --git a/...c/_static/serializing-a-version-1-2-0.svg → docs/assets/serializing-a-version-1-2-0.svg b/...c/_static/serializing-a-version-1-2-0.svg → docs/assets/serializing-a-version-1-2-0.svg
diff --git a/...c/_static/serializing-a-version-1-2-3.svg → docs/assets/serializing-a-version-1-2-3.svg b/...c/_static/serializing-a-version-1-2-3.svg → docs/assets/serializing-a-version-1-2-3.svg
diff --git a/docsrc/_static/serializing-a-version-1.svg → docs/assets/serializing-a-version-1.svg b/docsrc/_static/serializing-a-version-1.svg → docs/assets/serializing-a-version-1.svg
diff --git a/docsrc/explanation/index.md → docs/explanation/index.md b/docsrc/explanation/index.md → docs/explanation/index.md
diff --git a/docsrc/explanation/mental-model.md → docs/explanation/mental-model.md b/docsrc/explanation/mental-model.md → docs/explanation/mental-model.md
@@ -34,7 +34,7 @@ A **version serialization format** is a list of format strings used to serialize
 ### How a version spec is generated
 
 <figure markdown="span" style="width: 50%; float: right;padding-left: .75rem">
-    [![How a version spec is generated](../_static/creating-a-version-spec.svg)](../_static/creating-a-version-spec.svg)
+    [![How a version spec is generated](../assets/creating-a-version-spec.svg)](../assets/creating-a-version-spec.svg)
     <figcaption>How a configuration file is used to generate a version spec.</figcaption>
 </figure>
 
@@ -54,7 +54,7 @@ The _component dependency_ graph determines the order in which the _version comp
 ### How a version is generated
 
 <figure markdown="span" style="width: 50%; float: right;padding-left: .75rem">
-    [![How a version is generated](../_static/creating-a-version.svg)](../_static/creating-a-version.svg)
+    [![How a version is generated](../assets/creating-a-version.svg)](../assets/creating-a-version.svg)
     <figcaption>How a version spec is used to generate a version.</figcaption>
 </figure>
 
@@ -84,7 +84,7 @@ The `serialize` method of the _version spec_ returns either the optimal serializ
 
     ::: card-container depth-0
         ::: card-media
-            [![How a version is serialized with values major=1, minor=2, and patch=3](../_static/serializing-a-version-1-2-3.svg)](../_static/serializing-a-version-1-2-3.svg)
+            [![How a version is serialized with values major=1, minor=2, and patch=3](../assets/serializing-a-version-1-2-3.svg)](../assets/serializing-a-version-1-2-3.svg)
 
         ::: card-content
             No optional values
@@ -94,7 +94,7 @@ The `serialize` method of the _version spec_ returns either the optimal serializ
 
     ::: card-container depth-0
         ::: card-media
-            [![How a version is serialized with values major=1, minor=2, and patch=0](../_static/serializing-a-version-1-2-0.svg)](../_static/serializing-a-version-1-2-0.svg)
+            [![How a version is serialized with values major=1, minor=2, and patch=0](../assets/serializing-a-version-1-2-0.svg)](../assets/serializing-a-version-1-2-0.svg)
             
         ::: card-content
         
@@ -105,7 +105,7 @@ The `serialize` method of the _version spec_ returns either the optimal serializ
 
     ::: card-container depth-0
         ::: card-media
-            [![How a version is serialized with values major=1, minor=0, and patch=0](../_static/serializing-a-version-1-0-0.svg)](../_static/serializing-a-version-1-0-0.svg)
+            [![How a version is serialized with values major=1, minor=0, and patch=0](../assets/serializing-a-version-1-0-0.svg)](../assets/serializing-a-version-1-0-0.svg)
 
         ::: card-content
             Two optional values
@@ -115,7 +115,7 @@ The `serialize` method of the _version spec_ returns either the optimal serializ
 
     ::: card-container depth-0
         ::: card-media
-            [![How a version is serialized with invalid serialization formats](../_static/serializing-a-version-1.svg)](../_static/serializing-a-version-1.svg)
+            [![How a version is serialized with invalid serialization formats](../assets/serializing-a-version-1.svg)](../assets/serializing-a-version-1.svg)
 
         ::: card-content
             No valid serialization options

diff --git a/docsrc/gen_doc_stubs.py → docs/gen_doc_stubs.py b/docsrc/gen_doc_stubs.py → docs/gen_doc_stubs.py
diff --git a/...rc/howtos/avoid-incorrect-replacements.md → docs/howtos/avoid-incorrect-replacements.md b/...rc/howtos/avoid-incorrect-replacements.md → docs/howtos/avoid-incorrect-replacements.md
diff --git a/docsrc/howtos/calver.md → docs/howtos/calver.md b/docsrc/howtos/calver.md → docs/howtos/calver.md
diff --git a/.../howtos/custom-version-formats-by-file.md → .../howtos/custom-version-formats-by-file.md b/.../howtos/custom-version-formats-by-file.md → .../howtos/custom-version-formats-by-file.md
diff --git a/docsrc/howtos/index.md → docs/howtos/index.md b/docsrc/howtos/index.md → docs/howtos/index.md
diff --git a/docsrc/howtos/multiple-replacements.md → docs/howtos/multiple-replacements.md b/docsrc/howtos/multiple-replacements.md → docs/howtos/multiple-replacements.md
diff --git a/docsrc/howtos/update-a-date.md → docs/howtos/update-a-date.md b/docsrc/howtos/update-a-date.md → docs/howtos/update-a-date.md
diff --git a/docsrc/index.md → docs/index.md b/docsrc/index.md → docs/index.md
diff --git a/docsrc/reference/calver_reference.md → docs/reference/calver_reference.md b/docsrc/reference/calver_reference.md → docs/reference/calver_reference.md
diff --git a/docsrc/reference/cli.md → docs/reference/cli.md b/docsrc/reference/cli.md → docs/reference/cli.md
diff --git a/docsrc/reference/configuration.md → docs/reference/configuration.md b/docsrc/reference/configuration.md → docs/reference/configuration.md
diff --git a/docsrc/reference/formatting-context.md → docs/reference/formatting-context.md b/docsrc/reference/formatting-context.md → docs/reference/formatting-context.md
diff --git a/docsrc/reference/index.md → docs/reference/index.md b/docsrc/reference/index.md → docs/reference/index.md
diff --git a/...rc/reference/search-and-replace-config.md → docs/reference/search-and-replace-config.md b/...rc/reference/search-and-replace-config.md → docs/reference/search-and-replace-config.md
diff --git a/docsrc/reference/version-parts.md → docs/reference/version-parts.md b/docsrc/reference/version-parts.md → docs/reference/version-parts.md
diff --git a/docsrc/tutorials/index.md → docs/tutorials/index.md b/docsrc/tutorials/index.md → docs/tutorials/index.md
diff --git a/.../tutorials/semantic-versioning-example.md → .../tutorials/semantic-versioning-example.md b/.../tutorials/semantic-versioning-example.md → .../tutorials/semantic-versioning-example.md
diff --git a/docsrc/tutorials/usage.md → docs/tutorials/usage.md b/docsrc/tutorials/usage.md → docs/tutorials/usage.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,14 +2,13 @@ site_name: Bump My Version
 repo_url: https://github.com/callowayproject/bump-my-version
 edit_uri: edit/master/docs/
 copyright: Calloway Project
-docs_dir: docsrc
 watch:
   - overrides
 theme:
   name: material
   custom_dir: overrides
-  logo: _static/bump-my-version-logo.svg
-  favicon: _static/favicon.png
+  logo: assets/bump-my-version-logo.svg
+  favicon: assets/favicon.png
   features:
     - navigation.tabs
     - navigation.sections
@@ -78,7 +77,7 @@ plugins:
       nav_file: SUMMARY.md
   - gen-files:
       scripts:
-        - docsrc/gen_doc_stubs.py
+        - docs/gen_doc_stubs.py
   - mkdocstrings:
       custom_templates: overrides/mkdocstrings
       handlers:
@@ -111,10 +110,10 @@ extra_javascript:
   - "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML"
 
 extra_css:
-  - _static/css/custom.css
-  - _static/css/mkdocstrings.css
-  - _static/css/cards.css
-  - _static/css/field-list.css
+  - assets/css/custom.css
+  - assets/css/mkdocstrings.css
+  - assets/css/cards.css
+  - assets/css/field-list.css
 
 #nav:
 #  - General: "general/"

diff --git a/tools/drawioexport.py b/tools/drawioexport.py
@@ -128,8 +128,8 @@ def export_file_if_needed(source: Path, page_index: int, dest_path: Path) -> Non
         "serializing-a-version-1-2-0.svg",
         "serializing-a-version-1-2-3.svg",
     ]
-    source_path = Path(__file__).parent.parent.joinpath("docsrc/_static/bump-my-version-model.drawio")
-    dest_path = Path(__file__).parent.parent.joinpath("docsrc/_static/")
+    source_path = Path(__file__).parent.parent.joinpath("docs/assets/bump-my-version-model.drawio")
+    dest_path = Path(__file__).parent.parent.joinpath("docs/assets/")
     for index, filename in enumerate(output_files):
         filepath = dest_path.joinpath(filename)
         export_file_if_needed(source_path, index, filepath)