Adds maintenance section to docs

WGBH-MLA · Sep 9, 2024 · e99b7aa · e99b7aa
1 parent 5f502f0
commit e99b7aa
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/docs/pdm.md → docs/maintenance.md b/docs/pdm.md → docs/maintenance.md
@@ -1,6 +1,6 @@
-# PDM
+# Maintenance
 
-Package management scripts for ov-wag
+This page describes how to maintain the project. This includes [running scripts](#run-scripts), [creating lockfiles](#create-lockfiles), and [updating dependencies](#update-lockfiles).
 
 ## Install project
 
@@ -37,3 +37,23 @@ pdm update --prod -G production -L pdm-locks/pdm.prod.lock --unconstrained --sav
 # docs
 pdm update --no-default -G docs -L pdm-locks/pdm.doc.lock --unconstrained --save-compatible --no-self
 ```
+
+## Run tests
+
+```bash
+pytest
+```
+
+## Serve docs
+
+Use the project script shortcut:
+
+```bash
+ov-docs
+```
+
+Or pass custom arguments to the underlying command:
+
+```bash
+mkdocs serve [args]
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,6 +8,7 @@ nav:
   - Home: index.md
   - Setup: setup.md
   - Develop: dev.md
+  - Maintenance: maintenance.md
   - Reference: reference
 markdown_extensions:
   - admonition
@@ -19,7 +20,7 @@ markdown_extensions:
   - pymdownx.caret
   - pymdownx.details
   - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji 
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight
   - pymdownx.inlinehilite

diff --git a/pyproject.toml b/pyproject.toml
@@ -28,6 +28,7 @@ repository = 'https://github.com/WGBH-MLA/ov-wag'
 
 [project.scripts]
 ov = 'cli:app'
+ov-docs = 'mkdocs.commands:serve.serve'
 
 [project.optional-dependencies]
 cli = [