derivepassphrase.git

Update documentation to use new module names
Parent 4c74369
Marco Ricci

Marco Ricci commited on 2024-08-03 21:48:58
Zeige 10 geänderte Dateien mit 34 Einfügungen und 29 Löschungen. 

Let the documentation reflect the moving and splitting of modules in
26973402aac5d216a66ae3fc8f2d7bcb0fd7ea89.  The filenames are still
mostly the same, to keep links alive where possible.

Because the module list is now more tree-like than list-like, yet still
very small as a whole, abandon the table format in favor of a hierarchy
of (Markdown/HTML) lists.
docs/reference.md
Zeige Datei @ 4f6950f
... ... 
@@ -1,18 +1,19 @@
1 
-Man pages:
1 
+## Man pages
2 2
3 
-Item                             | Description
4 
--------------------------------- | ---------------------------------------------------------------
5 
-[`derivepassphrase(1)`][dpp_man] | A deterministic, stateless password manager: command-line tool.
3 
+* [`derivepassphrase(1)`][cli_man]: A deterministic, stateless password manager: command-line tool.
6 4
7 
-Top-level modules:
5 
+## Modules and packages
8 6
9 
-Module                           | Description
10 
--------------------------------- | --------------------------------------------------------------------
11 
-[`derivepassphrase`][dpp_module] | Work-alike for vault(1) - deterministic, stateless password manager.
12 
-[`sequin`][]                     | Python port of Sequin, a pseudorandom number generator.
13 
-[`ssh_agent_client`][]           | A bare-bones SSH agent client supporting signing and key listing.
7 
+* `derivepassphrase`: Work-alike for vault(1) – deterministic, stateless password manager.
8 
+    * [`derivepassphrase.cli`][cli_module]: Command-line interface for `derivepassphrase`.
9 
+    * [`derivepassphrase.sequin`][sequin]: Python port of Sequin, a pseudorandom number generator.
10 
+    * [`derivepassphrase.ssh_agent`][ssh_agent]: A bare-bones SSH agent client supporting signing and key listing.
11 
+    * [`derivepassphrase._types`][types_module]: Types used by `derivepassphrase`.
12 
+    * [`derivepassphrase.vault`][vault_module]: Python port of the vault(1) password generation scheme.
14 13
15 
-  [dpp_man]: reference/derivepassphrase.1.md
16 
-  [dpp_module]: reference/derivepassphrase.md
14 
+  [cli_man]: reference/derivepassphrase.1.md
15 
+  [cli_module]: reference/derivepassphrase.md
17 16 
   [sequin]: reference/sequin.md
18 
-  [ssh_agent_client]: reference/ssh_agent_client.md
17 
+  [ssh_agent]: reference/ssh_agent.md
18 
+  [types_module]: reference/types.md
19 
+  [vault_module]: reference/vault.md
docs/reference/derivepassphrase.md
Zeige Datei @ 4f6950f
... ... 
@@ -1,4 +1,2 @@
1 
-::: derivepassphrase
1 
+::: derivepassphrase.cli
2 2 
     heading_level: 1
3 
-    options:
4 
-      show_submodules: true
docs/reference/sequin.md
Zeige Datei @ 4f6950f
... ... 
@@ -1,2 +1,2 @@
1 
-::: sequin
1 
+::: derivepassphrase.sequin
2 2 
     heading_level: 1
docs/reference/ssh_agent.md
Zeige Datei @ 4f6950f
... ... 
@@ -0,0 +1,2 @@
1 
+::: derivepassphrase.ssh_agent
2 
+    heading_level: 1
docs/reference/ssh_agent_client.md
Zeige Datei @ 4c74369
... ... 
@@ -1,4 +0,0 @@
1 
-::: ssh_agent_client
2 
-    heading_level: 1
3 
-    options:
4 
-      show_submodules: true
docs/reference/types.md
Zeige Datei @ 4f6950f
... ... 
@@ -0,0 +1,2 @@
1 
+::: derivepassphrase._types
2 
+    heading_level: 1
docs/reference/vault.md
Zeige Datei @ 4f6950f
... ... 
@@ -0,0 +1,2 @@
1 
+::: derivepassphrase.vault
2 
+    heading_level: 1
mkdocs.yml
Zeige Datei @ 4f6950f
... ... 
@@ -91,9 +91,12 @@ nav:
91 91 
   - Reference:
92 92 
     - Reference overview: reference.md
93 93 
     - 'Man page: derivepassphrase': reference/derivepassphrase.1.md
94 
-    - Module derivepassphrase: reference/derivepassphrase.md
95 
-    - Module sequin: reference/sequin.md
96 
-    - Module ssh_agent_client: reference/ssh_agent_client.md
94 
+    - Module derivepassphrase:
95 
+      - Submodule cli: reference/derivepassphrase.md
96 
+      - Submodule sequin: reference/sequin.md
97 
+      - Submodule ssh_agent: reference/ssh_agent.md
98 
+      - Submodule _types: reference/types.md
99 
+      - Submodule vault: reference/vault.md
97 100 
   #- Design & Background: explanation.md
98 101 
   - Changelog: changelog.md
99 102
src/derivepassphrase/_types.py
Zeige Datei @ 4f6950f
... ... 
@@ -2,7 +2,7 @@
2 2 
 #
3 3 
 # SPDX-License-Identifier: MIT
4 4
5 
-"""Common typing declarations for the parent module."""
5 
+"""Types used by derivepassphrase."""
6 6
7 7 
 from __future__ import annotations
8 8
src/derivepassphrase/vault.py
Zeige Datei @ 4f6950f
... ... 
@@ -2,7 +2,7 @@
2 2 
 #
3 3 
 # SPDX-License-Identifier: MIT
4 4
5 
-"""Work-alike of vault(1) – a deterministic, stateless password manager"""  # noqa: RUF002
5 
+"""Python port of the vault(1) password generation scheme"""
6 6
7 7 
 from __future__ import annotations
8 8
... ... 
@@ -59,9 +59,10 @@ class Vault:
59 59 
     detail][ALGORITHM] in his blog post on said topic: A principally
60 60 
     infinite bit stream is obtained by running a key-derivation function
61 61 
     on the master passphrase and the service name, then this bit stream
62 
-    is fed into a [Sequin][sequin.Sequin] to generate random numbers in
63 
-    the correct range, and finally these random numbers select
64 
-    passphrase characters until the desired length is reached.
62 
+    is fed into a [Sequin][derivepassphrase.sequin.Sequin] to generate
63 
+    random numbers in the correct range, and finally these random
64 
+    numbers select passphrase characters until the desired length is
65 
+    reached.
65 66
66 67 
     [vault]: https://getvau.lt
67 68 
     [ALGORITHM]: https://blog.jcoglan.com/2012/07/16/designing-vaults-generator-algorithm/
68 69