derivepassphrase.git

Fix minor oversights in the documentation
Parent 8eab160
Marco Ricci

Marco Ricci commited on 2025-06-21 15:04:12
Zeige 5 geänderte Dateien mit 8 Einfügungen und 4 Löschungen. 

The interal "Future ideas" page now also includes the same icons as the
changelog uses for referring to bugs and wishlist entries.

The wishlist path is slightly different, depending on whether MkDocs
builds in "online" or "offline" mode.  The CSS needs to accomodate both
paths.

The main API documentation should not attempt to refer to internals by
hyperlink.
docs/_future.md
Zeige Datei @ 0247f35
... ... 
@@ -6,7 +6,7 @@
6 6
7 7 
 ### Derivation schemes
8 8
9 
-* `spectre` (`master-password`): derive passphrases according to the "Master Password" scheme as used by the Spectre app. ([#2])
9 
+* `spectre` (`master-password`): derive passphrases according to the "Master Password" scheme as used by the Spectre app. →[:material-gift:][WISH_OTHER_DERIVATION_SCHEMES]
10 10
11 11 
 ### Other functionality
12 12
... ... 
@@ -36,7 +36,7 @@
36 36
37 37 
         - Interface with `inotifywait` to wait for SSH control socket?
38 38
39 
-[#2]: https://github.com/the-13th-letter/derivepassphrase/issues/2
39 
+[WISH_OTHER_DERIVATION_SCHEMES]: wishlist/other-derivation-schemes.md "Wish entry: “Consider implementing passphrase schemes other than vault's”"
40 40
41 41 
 ## Documentation
42 42
docs/wishlist_styling.css
Zeige Datei @ 0247f35
... ... 
@@ -36,6 +36,9 @@ a.fixed {
36 36 
 .md-typeset div.admonition.abstract .emojione,
37 37 
 .md-typeset div.admonition.abstract .gemoji,
38 38 
 .md-typeset div.admonition.abstract .twemoji,
39 
+.md-typeset a[href^="../wishlist/"] .emojione,
40 
+.md-typeset a[href^="../wishlist/"] .gemoji,
41 
+.md-typeset a[href^="../wishlist/"] .twemoji,
39 42 
 .md-typeset a[href^="wishlist/"] .emojione,
40 43 
 .md-typeset a[href^="wishlist/"] .gemoji,
41 44 
 .md-typeset a[href^="wishlist/"] .twemoji {
mkdocs.yml
Zeige Datei @ 0247f35
... ... 
@@ -130,6 +130,7 @@ not_in_nav: |
130 130 
 draft_docs: |
131 131 
   changelog.d
132 132 
   _future.md
133 
+  reference/derivepassphrase._internals.*
133 134 
   reference/tests.*
134 135
135 136 
 markdown_extensions:
mkdocs_offline.yml
Zeige Datei @ 0247f35
... ... 
@@ -2,6 +2,7 @@ INHERIT: mkdocs.yml
2 2
3 3 
 draft_docs: |
4 4 
   _future.md
5 
+  reference/derivepassphrase._internals.*
5 6 
   reference/tests.*
6 7 
 not_in_nav: |
7 8 
   changelog.d
src/derivepassphrase/cli.py
Zeige Datei @ 0247f35
... ... 
@@ -752,8 +752,7 @@ class _VaultContext:  # noqa: PLR0904
752 752 
             If the requested operation is a read-only operation, return
753 753 
             a no-op mutex.  (Concurrent reads are always allowed, even
754 754 
             in the presence of writers.)  Otherwise, for read-write
755 
-            operations, returns the result from
756 
-            [`cli_helpers.configuration_mutex`][].
755 
+            operations, return an actual mutex.
757 756
758 757 
         """
759 758 
         return (
760 759