docs: update

afuetterer · May 17, 2024 · ddf71b6 · ddf71b6
1 parent efd117c
commit ddf71b6
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 54 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/gen_ref_pages.py b/docs/gen_ref_pages.py
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/license.md b/docs/license.md
diff --git a/mkdocs.yml → docs/mkdocs.yml b/mkdocs.yml → docs/mkdocs.yml
@@ -6,18 +6,20 @@ site_name: services-test4
 site_description: services-test4
 repo_name: afuetterer/services-test4
 repo_url: https://github.com/afuetterer/services-test4
-watch: [README.md, src/services_test4]
+docs_dir: src
+edit_uri: edit/main/docs/
+strict: true
+watch:
+- ../src
 
 nav:
   - Home: index.md
-  # - Usage: cli.md
-  # - Reference: reference/
   - Changelog: changelog.md
   - License: license.md
 
 theme:
   name: material
-  custom_dir: docs/overrides
+  custom_dir: src/overrides
   features:
     - content.code.annotate
 
@@ -29,12 +31,6 @@ plugins:
   #         options:
   #           docstring_style: google
   - include-markdown
-  - gen-files:
-      scripts:
-        - docs/gen_ref_pages.py
-  - literate-nav:
-      nav_file: SUMMARY.md
-  - section-index
 
 markdown_extensions:
   - admonition

diff --git a/docs/src/changelog.md b/docs/src/changelog.md
@@ -0,0 +1 @@
+{% include-markdown "../../CHANGELOG.md" %}
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1 @@
+{% include-markdown "../../README.md" %}
diff --git a/docs/src/license.md b/docs/src/license.md
@@ -0,0 +1 @@
+{% include-markdown "../../LICENSE.md" %}
diff --git a/docs/overrides/main.html → docs/src/overrides/main.html b/docs/overrides/main.html → docs/src/overrides/main.html
diff --git a/pyproject.toml b/pyproject.toml
@@ -109,9 +109,9 @@ all = [
 features = ["docs"]
 
 [tool.hatch.envs.docs.scripts]
-build = "mkdocs build --verbose"
-serve = "mkdocs serve --verbose"
-deploy = "mike deploy --push --update-aliases $(hatch version) latest"
+build = "mkdocs build --verbose --config-file=docs/mkdocs.yml"
+serve = "mkdocs serve --verbose --config-file=docs/mkdocs.yml"
+deploy = "mike deploy --push --update-aliases $(hatch version) latest --config-file=docs/mkdocs.yml"
 
 # black
 # Ref: https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
@@ -216,10 +216,10 @@ logging_use_named_masks = true
 major_on_zero = false
 tag_format = "{version}"
 version_toml = ["pyproject.toml:project.version"]
-assets = ["CITATION.cff"]
 build_command = """
 sed -i "s/^version: .*/version: $NEW_VERSION/" CITATION.cff
 sed -i "s/^date-released: .*/date-released: $(date "+%Y-%m-%d")/" CITATION.cff
+git add CITATION.cff
 python -m pip install "build[uv]>=1.2.1"
 python -m build --installer=uv
 """