Streamline documentation file structure and linking
Marco Ricci commited on 2024-09-01 16:27:34
Zeige 4 geänderte Dateien mit 25 Einfügungen und 26 Löschungen.
Use the "index page" functionality and the unpruned navigation list from MkDocs/Material, and use the module autorefs on the documentation overview page.
- docs/changelog.md 2ea1c04..3e10626
- docs/reference.md d544f66..0000000
- docs/reference/index.md 0000000..15c3ac9
- mkdocs.yml 7b1a9b1..bb4abbd
| ... | ... |
@@ -26,7 +26,7 @@ justification is not yet binding, and <em>any</em> new release may |
| 26 | 26 |
effectively constitute a new <q>major</q> release.) |
| 27 | 27 |
</small></aside> |
| 28 | 28 |
|
| 29 |
- [REFERENCE]: reference.md |
|
| 29 |
+ [REFERENCE]: reference/index.md |
|
| 30 | 30 |
|
| 31 | 31 |
<!-- towncrier release notes start --> |
| 32 | 32 |
|
| ... | ... |
@@ -1,22 +0,0 @@ |
| 1 |
-## Man pages |
|
| 2 |
- |
|
| 3 |
-* [`derivepassphrase(1)`][cli_man]: A deterministic, stateless password manager: command-line tool. |
|
| 4 |
- |
|
| 5 |
-## Modules and packages |
|
| 6 |
- |
|
| 7 |
-* `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager. |
|
| 8 |
- * [`derivepassphrase.cli`][cli_module]: Command-line interface for `derivepassphrase`. |
|
| 9 |
- * [`derivepassphrase.exporter`][]: Exporter for other passphrase generator configurations. |
|
| 10 |
- * [`derivepassphrase.exporter.storeroom`][]: Exporter for the vault "storeroom" configuration format. |
|
| 11 |
- * [`derivepassphrase.exporter.vault_native`][]: Exporter for the vault native configuration formats (v0.2 and v0.3). |
|
| 12 |
- * [`derivepassphrase.sequin`][sequin]: Python port of Sequin, a pseudorandom number generator. |
|
| 13 |
- * [`derivepassphrase.ssh_agent`][ssh_agent]: A bare-bones SSH agent client supporting signing and key listing. |
|
| 14 |
- * [`derivepassphrase._types`][types_module]: Types used by `derivepassphrase`. |
|
| 15 |
- * [`derivepassphrase.vault`][vault_module]: Python port of the vault(1) password generation scheme. |
|
| 16 |
- |
|
| 17 |
- [cli_man]: reference/derivepassphrase.1.md |
|
| 18 |
- [cli_module]: reference/derivepassphrase.md |
|
| 19 |
- [sequin]: reference/sequin.md |
|
| 20 |
- [ssh_agent]: reference/ssh_agent.md |
|
| 21 |
- [types_module]: reference/types.md |
|
| 22 |
- [vault_module]: reference/vault.md |
| ... | ... |
@@ -0,0 +1,21 @@ |
| 1 |
+--- |
|
| 2 |
+title: Reference overview |
|
| 3 |
+--- |
|
| 4 |
+ |
|
| 5 |
+## Man pages |
|
| 6 |
+ |
|
| 7 |
+* [`derivepassphrase(1)`][cli_man]: A deterministic, stateless password manager: command-line tool. |
|
| 8 |
+ |
|
| 9 |
+## Modules and packages |
|
| 10 |
+ |
|
| 11 |
+* `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager. |
|
| 12 |
+ * [`derivepassphrase.cli`][]: Command-line interface for `derivepassphrase`. |
|
| 13 |
+ * [`derivepassphrase.exporter`][]: Exporter for other passphrase generator configurations. |
|
| 14 |
+ * [`derivepassphrase.exporter.storeroom`][]: Exporter for the vault "storeroom" configuration format. |
|
| 15 |
+ * [`derivepassphrase.exporter.vault_native`][]: Exporter for the vault native configuration formats (v0.2 and v0.3). |
|
| 16 |
+ * [`derivepassphrase.sequin`][]: Python port of Sequin, a pseudorandom number generator. |
|
| 17 |
+ * [`derivepassphrase.ssh_agent`][]: A bare-bones SSH agent client supporting signing and key listing. |
|
| 18 |
+ * [`derivepassphrase._types`][]: Types used by `derivepassphrase`. |
|
| 19 |
+ * [`derivepassphrase.vault`][]: Python port of the vault(1) password generation scheme. |
|
| 20 |
+ |
|
| 21 |
+ [cli_man]: derivepassphrase.1.md |
| ... | ... |
@@ -43,9 +43,9 @@ theme: |
| 43 | 43 |
- content.code.annotate |
| 44 | 44 |
- navigation.tracking |
| 45 | 45 |
- navigation.tabs |
| 46 |
- - navigation.prune |
|
| 46 |
+ - navigation.sections |
|
| 47 |
+ - navigation.indexes |
|
| 47 | 48 |
- navigation.footer |
| 48 |
- - toc.follow |
|
| 49 | 49 |
custom_dir: docs-overrides |
| 50 | 50 |
|
| 51 | 51 |
plugins: |
| ... | ... |
@@ -91,7 +91,7 @@ nav: |
| 91 | 91 |
#- Tutorials & Examples: tutorials.md |
| 92 | 92 |
#- How-Tos: how-tos.md |
| 93 | 93 |
- Reference: |
| 94 |
- - Reference overview: reference.md |
|
| 94 |
+ - reference/index.md |
|
| 95 | 95 |
- 'Man page: derivepassphrase': reference/derivepassphrase.1.md |
| 96 | 96 |
- Module derivepassphrase: |
| 97 | 97 |
- Submodule cli: reference/derivepassphrase.md |
| 98 | 98 |