derivepassphrase.git

Deploy versioned documentation with `mike`
Parent df4e332
Marco Ricci

Marco Ricci commited on 2024-07-28 19:56:43
Zeige 3 geänderte Dateien mit 9 Einfügungen und 0 Löschungen. 

In anticipation of v1.0 and more potential stable branches to follow,
set up the documentation such that each major development branch gets
its own documentation directory.
mkdocs.yml
Zeige Datei @ e5b0441
... ... 
@@ -6,6 +6,9 @@ site_description: An almost faithful Python reimplementation of James Coglan's v
6 6 
 site_author: Marco Ricci
7 7 
 copyright: Copyright © 2024 Marco Ricci (the-13th-letter)
8 8
9 
+remote_branch: documentation-tree
10 
+remote_name: '.'
11 
+
9 12 
 docs_dir: docs
10 13 
 site_dir: html
11 14 
 extra_css:
... ... 
@@ -76,6 +79,10 @@ plugins:
76 79 
           unwrap_annotated: true
77 80 
         paths:
78 81 
           - src
82 
+  mike:
83 
+    alias_type: symlink
84 
+    canonical_version: '0.x'
85 
+    version_selector: false
79 86
80 87 
 nav:
81 88 
   - Overview: index.md
pyproject.toml
Zeige Datei @ e5b0441
... ... 
@@ -82,6 +82,7 @@ path = "mkdocs.yml"
82 82 
 [tool.hatch.envs.docs]
83 83 
 extra-dependencies = [
84 84 
   "black",
85 
+  "mike",
85 86 
   "mkdocs-material",
86 87 
 ]
87 88 
 detached = false
towncrier.d/+mike.fixed.md
Zeige Datei @ e5b0441
... ... 
@@ -0,0 +1 @@
1 
+Deploy versioned documentation with [mike](https://pypi.org/project/mike).  Set up a "latest" tag and the "0.<var>x</var>" version of the documentation with the contents so far.
0 2