Add exporter modules to the documentation
Marco Ricci commited on 2024-09-01 16:19:55
Zeige 4 geänderte Dateien mit 17 Einfügungen und 2 Löschungen.
The two exporter submodules `storeroom` and `vault_native` are short enough and thematically related, so they are placed on a common page "Exporters for vault".
- docs/reference.md 25a1914..d544f66
- docs/reference/exporter.md 0000000..1a2f2d2
- docs/reference/exporter_vault.md 0000000..105e1a9
- mkdocs.yml 12fb233..7b1a9b1
| ... | ... |
@@ -6,6 +6,9 @@ |
| 6 | 6 |
|
| 7 | 7 |
* `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager. |
| 8 | 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). |
|
| 9 | 12 |
* [`derivepassphrase.sequin`][sequin]: Python port of Sequin, a pseudorandom number generator. |
| 10 | 13 |
* [`derivepassphrase.ssh_agent`][ssh_agent]: A bare-bones SSH agent client supporting signing and key listing. |
| 11 | 14 |
* [`derivepassphrase._types`][types_module]: Types used by `derivepassphrase`. |
| ... | ... |
@@ -57,8 +57,10 @@ plugins: |
| 57 | 57 |
handlers: |
| 58 | 58 |
python: |
| 59 | 59 |
import: |
| 60 |
- - https://docs.python.org/3/objects.inv |
|
| 61 |
- - https://click.palletsprojects.com/en/8.1.x/objects.inv |
|
| 60 |
+ - 'https://docs.python.org/3/objects.inv' |
|
| 61 |
+ - 'https://click.palletsprojects.com/en/8.1.x/objects.inv' |
|
| 62 |
+ - 'https://typing-extensions.readthedocs.io/en/latest/objects.inv' |
|
| 63 |
+ - 'https://cryptography.readthedocs.io/en/latest/objects.inv' |
|
| 62 | 64 |
options: |
| 63 | 65 |
docstring_options: |
| 64 | 66 |
ignore_init_summary: true |
| ... | ... |
@@ -93,6 +95,9 @@ nav: |
| 93 | 95 |
- 'Man page: derivepassphrase': reference/derivepassphrase.1.md |
| 94 | 96 |
- Module derivepassphrase: |
| 95 | 97 |
- Submodule cli: reference/derivepassphrase.md |
| 98 |
+ - Subpackage exporter: |
|
| 99 |
+ - Subpackage exporter: reference/exporter.md |
|
| 100 |
+ - Exporters for vault: reference/exporter_vault.md |
|
| 96 | 101 |
- Submodule sequin: reference/sequin.md |
| 97 | 102 |
- Submodule ssh_agent: reference/ssh_agent.md |
| 98 | 103 |
- Submodule _types: reference/types.md |
| 99 | 104 |