Add tests API documentation to "dev setup" MkDocs build
Marco Ricci commited on 2025-01-23 11:58:44
Zeige 12 geänderte Dateien mit 54 Einfügungen und 0 Löschungen.
Most API documentation is highly deficient at this point, but exposing it in this way hopefully makes it more likely I'll get to documenting the tests. The hope for the future is that it might be faster to consult the API documentation than to skim through the test file to see if and where a certain aspect is being tested, whether the classes are too large, etc.
- docs/reference/tests.md 0000000..46607a0
- docs/reference/tests.test_derivepassphrase_cli.md 0000000..5b9f188
- docs/reference/tests.test_derivepassphrase_cli_export_vault.md 0000000..601c2be
- docs/reference/tests.test_derivepassphrase_exporter.md 0000000..82a9abc
- docs/reference/tests.test_derivepassphrase_sequin.md 0000000..8053c5a
- docs/reference/tests.test_derivepassphrase_ssh_agent.md 0000000..6a376b6
- docs/reference/tests.test_derivepassphrase_types.md 0000000..444ead2
- docs/reference/tests.test_derivepassphrase_vault.md 0000000..16b2b2f
- docs/reference/tests.test_l10n.md 0000000..5b346ae
- mkdocs.yml 7a5be45..abd7171
- mkdocs_devsetup.yml c830d77..990be44
- mkdocs_offline.yml 27e70c9..6647552
| ... | ... |
@@ -81,6 +81,7 @@ plugins: |
| 81 | 81 |
scoped_crossrefs: true |
| 82 | 82 |
paths: |
| 83 | 83 |
- src |
| 84 |
+ - . |
|
| 84 | 85 |
mike: |
| 85 | 86 |
alias_type: symlink |
| 86 | 87 |
canonical_version: '0.x' |
| ... | ... |
@@ -122,6 +123,7 @@ nav: |
| 122 | 123 |
draft_docs: | |
| 123 | 124 |
changelog.d |
| 124 | 125 |
_future.md |
| 126 |
+ reference/tests.* |
|
| 125 | 127 |
|
| 126 | 128 |
markdown_extensions: |
| 127 | 129 |
- abbr |
| ... | ... |
@@ -30,6 +30,17 @@ nav: |
| 30 | 30 |
- Submodule vault: reference/derivepassphrase.vault.md |
| 31 | 31 |
- Technical prerequisites: |
| 32 | 32 |
- 'Using derivepassphrase vault with an SSH key': reference/prerequisites-ssh-key.md |
| 33 |
+ - Tests: |
|
| 34 |
+ - Basic testing infrastructure: reference/tests.md |
|
| 35 |
+ - Localization machinery: reference/tests.test_l10n.md |
|
| 36 |
+ - derivepassphrase command-line: |
|
| 37 |
+ - cli module: reference/tests.test_derivepassphrase_cli.md |
|
| 38 |
+ - '"export vault" subcommand tests': reference/tests.test_derivepassphrase_cli_export_vault.md |
|
| 39 |
+ - exporter module: reference/tests.test_derivepassphrase_exporter.md |
|
| 40 |
+ - sequin module: reference/tests.test_derivepassphrase_sequin.md |
|
| 41 |
+ - ssh_agent module: reference/tests.test_derivepassphrase_ssh_agent.md |
|
| 42 |
+ - _types module: reference/tests.test_derivepassphrase_types.md |
|
| 43 |
+ - vault module: reference/tests.test_derivepassphrase_vault.md |
|
| 33 | 44 |
- Design & Background: |
| 34 | 45 |
- explanation/index.md |
| 35 | 46 |
- '"altered versions" license requirement': explanation/faq-altered-versions.md |