diff --git a/docsrc/CHANGELOG.md b/docs/CHANGELOG.md
similarity index 100%
rename from docsrc/CHANGELOG.md
rename to docs/CHANGELOG.md
diff --git a/docsrc/CONTRIBUTING.md b/docs/CONTRIBUTING.md
similarity index 100%
rename from docsrc/CONTRIBUTING.md
rename to docs/CONTRIBUTING.md
diff --git a/docsrc/LICENSE b/docs/LICENSE
similarity index 100%
rename from docsrc/LICENSE
rename to docs/LICENSE
diff --git a/docsrc/_static/bump-my-version-logo.svg b/docs/assets/bump-my-version-logo.svg
similarity index 100%
rename from docsrc/_static/bump-my-version-logo.svg
rename to docs/assets/bump-my-version-logo.svg
diff --git a/docsrc/_static/bump-my-version-model.drawio b/docs/assets/bump-my-version-model.drawio
similarity index 100%
rename from docsrc/_static/bump-my-version-model.drawio
rename to docs/assets/bump-my-version-model.drawio
diff --git a/docsrc/_static/creating-a-version-spec.svg b/docs/assets/creating-a-version-spec.svg
similarity index 100%
rename from docsrc/_static/creating-a-version-spec.svg
rename to docs/assets/creating-a-version-spec.svg
diff --git a/docsrc/_static/creating-a-version.svg b/docs/assets/creating-a-version.svg
similarity index 100%
rename from docsrc/_static/creating-a-version.svg
rename to docs/assets/creating-a-version.svg
diff --git a/docsrc/_static/css/cards.css b/docs/assets/css/cards.css
similarity index 100%
rename from docsrc/_static/css/cards.css
rename to docs/assets/css/cards.css
diff --git a/docsrc/_static/css/custom.css b/docs/assets/css/custom.css
similarity index 100%
rename from docsrc/_static/css/custom.css
rename to docs/assets/css/custom.css
diff --git a/docsrc/_static/css/field-list.css b/docs/assets/css/field-list.css
similarity index 100%
rename from docsrc/_static/css/field-list.css
rename to docs/assets/css/field-list.css
diff --git a/docsrc/_static/css/mkdocstrings.css b/docs/assets/css/mkdocstrings.css
similarity index 100%
rename from docsrc/_static/css/mkdocstrings.css
rename to docs/assets/css/mkdocstrings.css
diff --git a/docsrc/_static/serializing-a-version-1-0-0.svg b/docs/assets/serializing-a-version-1-0-0.svg
similarity index 100%
rename from docsrc/_static/serializing-a-version-1-0-0.svg
rename to docs/assets/serializing-a-version-1-0-0.svg
diff --git a/docsrc/_static/serializing-a-version-1-2-0.svg b/docs/assets/serializing-a-version-1-2-0.svg
similarity index 100%
rename from docsrc/_static/serializing-a-version-1-2-0.svg
rename to docs/assets/serializing-a-version-1-2-0.svg
diff --git a/docsrc/_static/serializing-a-version-1-2-3.svg b/docs/assets/serializing-a-version-1-2-3.svg
similarity index 100%
rename from docsrc/_static/serializing-a-version-1-2-3.svg
rename to docs/assets/serializing-a-version-1-2-3.svg
diff --git a/docsrc/_static/serializing-a-version-1.svg b/docs/assets/serializing-a-version-1.svg
similarity index 100%
rename from docsrc/_static/serializing-a-version-1.svg
rename to docs/assets/serializing-a-version-1.svg
diff --git a/docsrc/explanation/index.md b/docs/explanation/index.md
similarity index 100%
rename from docsrc/explanation/index.md
rename to docs/explanation/index.md
diff --git a/docsrc/explanation/mental-model.md b/docs/explanation/mental-model.md
similarity index 90%
rename from docsrc/explanation/mental-model.md
rename to docs/explanation/mental-model.md
index 0a14f5ff..0ac1eb8a 100644
--- a/docsrc/explanation/mental-model.md
+++ b/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
- [](../_static/creating-a-version-spec.svg)
+ [](../assets/creating-a-version-spec.svg)
How a configuration file is used to generate a version spec.
@@ -54,7 +54,7 @@ The _component dependency_ graph determines the order in which the _version comp
### How a version is generated
- [](../_static/creating-a-version.svg)
+ [](../assets/creating-a-version.svg)
How a version spec is used to generate a version.
@@ -84,7 +84,7 @@ The `serialize` method of the _version spec_ returns either the optimal serializ
::: card-container depth-0
::: card-media
- [](../_static/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
- [](../_static/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
- [](../_static/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
- [](../_static/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 b/docs/gen_doc_stubs.py
similarity index 100%
rename from docsrc/gen_doc_stubs.py
rename to docs/gen_doc_stubs.py
diff --git a/docsrc/howtos/avoid-incorrect-replacements.md b/docs/howtos/avoid-incorrect-replacements.md
similarity index 100%
rename from docsrc/howtos/avoid-incorrect-replacements.md
rename to docs/howtos/avoid-incorrect-replacements.md
diff --git a/docsrc/howtos/calver.md b/docs/howtos/calver.md
similarity index 100%
rename from docsrc/howtos/calver.md
rename to docs/howtos/calver.md
diff --git a/docsrc/howtos/custom-version-formats-by-file.md b/docs/howtos/custom-version-formats-by-file.md
similarity index 100%
rename from docsrc/howtos/custom-version-formats-by-file.md
rename to docs/howtos/custom-version-formats-by-file.md
diff --git a/docsrc/howtos/index.md b/docs/howtos/index.md
similarity index 100%
rename from docsrc/howtos/index.md
rename to docs/howtos/index.md
diff --git a/docsrc/howtos/multiple-replacements.md b/docs/howtos/multiple-replacements.md
similarity index 100%
rename from docsrc/howtos/multiple-replacements.md
rename to docs/howtos/multiple-replacements.md
diff --git a/docsrc/howtos/update-a-date.md b/docs/howtos/update-a-date.md
similarity index 100%
rename from docsrc/howtos/update-a-date.md
rename to docs/howtos/update-a-date.md
diff --git a/docsrc/index.md b/docs/index.md
similarity index 100%
rename from docsrc/index.md
rename to docs/index.md
diff --git a/docsrc/reference/calver_reference.md b/docs/reference/calver_reference.md
similarity index 100%
rename from docsrc/reference/calver_reference.md
rename to docs/reference/calver_reference.md
diff --git a/docsrc/reference/cli.md b/docs/reference/cli.md
similarity index 100%
rename from docsrc/reference/cli.md
rename to docs/reference/cli.md
diff --git a/docsrc/reference/configuration.md b/docs/reference/configuration.md
similarity index 100%
rename from docsrc/reference/configuration.md
rename to docs/reference/configuration.md
diff --git a/docsrc/reference/formatting-context.md b/docs/reference/formatting-context.md
similarity index 100%
rename from docsrc/reference/formatting-context.md
rename to docs/reference/formatting-context.md
diff --git a/docsrc/reference/index.md b/docs/reference/index.md
similarity index 100%
rename from docsrc/reference/index.md
rename to docs/reference/index.md
diff --git a/docsrc/reference/search-and-replace-config.md b/docs/reference/search-and-replace-config.md
similarity index 100%
rename from docsrc/reference/search-and-replace-config.md
rename to docs/reference/search-and-replace-config.md
diff --git a/docsrc/reference/version-parts.md b/docs/reference/version-parts.md
similarity index 100%
rename from docsrc/reference/version-parts.md
rename to docs/reference/version-parts.md
diff --git a/docsrc/tutorials/index.md b/docs/tutorials/index.md
similarity index 100%
rename from docsrc/tutorials/index.md
rename to docs/tutorials/index.md
diff --git a/docsrc/tutorials/semantic-versioning-example.md b/docs/tutorials/semantic-versioning-example.md
similarity index 100%
rename from docsrc/tutorials/semantic-versioning-example.md
rename to docs/tutorials/semantic-versioning-example.md
diff --git a/docsrc/tutorials/usage.md b/docs/tutorials/usage.md
similarity index 100%
rename from docsrc/tutorials/usage.md
rename to docs/tutorials/usage.md
diff --git a/mkdocs.yml b/mkdocs.yml
index 8ad6ff6f..1267be10 100644
--- 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
index 3d22a27e..0b579b25 100644
--- 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)