Rename reference documentation pages as per the Python standard library convention
Marco Ricci commited on 2024-09-22 19:34:40
Zeige 8 geänderte Dateien mit 10 Einfügungen und 11 Löschungen.
A module `spam.ham.eggs` shall be documented in a file `spam.ham.eggs.html`, or otherwise in `spam.ham.html` or `spam.html` if its documentation is to be grouped with other sibling modules. In particular, documentation is not nested into subdirectories, and the documentation filename is guessable based on the full module path. This entails consolidating the `derivepassphrase.exporter` module and its submodules into the same documentation page.
- docs/reference/types.md
- docs/reference/derivepassphrase.md
- docs/reference/exporter_vault.md 105e1a9..4714ac9
- docs/reference/sequin.md
- docs/reference/ssh_agent.md
- docs/reference/vault.md
- docs/reference/exporter.md 1a2f2d2..0000000
- mkdocs.yml 4cc69a0..4f32a40
| ... | ... |
@@ -97,14 +97,12 @@ nav: |
| 97 | 97 |
- 'Man page: derivepassphrase-export': reference/derivepassphrase-export.1.md |
| 98 | 98 |
- 'Man page: derivepassphrase-export-vault': reference/derivepassphrase-export-vault.1.md |
| 99 | 99 |
- Module derivepassphrase: |
| 100 |
- - Submodule cli: reference/derivepassphrase.md |
|
| 101 |
- - Subpackage exporter: |
|
| 102 |
- - Subpackage exporter: reference/exporter.md |
|
| 103 |
- - Exporters for vault: reference/exporter_vault.md |
|
| 104 |
- - Submodule sequin: reference/sequin.md |
|
| 105 |
- - Submodule ssh_agent: reference/ssh_agent.md |
|
| 106 |
- - Submodule _types: reference/types.md |
|
| 107 |
- - Submodule vault: reference/vault.md |
|
| 100 |
+ - Submodule cli: reference/derivepassphrase.cli.md |
|
| 101 |
+ - Subpackage exporter: reference/derivepassphrase.exporter.md |
|
| 102 |
+ - Submodule sequin: reference/derivepassphrase.sequin.md |
|
| 103 |
+ - Submodule ssh_agent: reference/derivepassphrase.ssh_agent.md |
|
| 104 |
+ - Submodule _types: reference/derivepassphrase._types.md |
|
| 105 |
+ - Submodule vault: reference/derivepassphrase.vault.md |
|
| 108 | 106 |
#- Design & Background: explanation.md |
| 109 | 107 |
- Changelog: changelog.md |
| 110 | 108 |
|
| 111 | 109 |