derivepassphrase.git

1) site_name: derivepassphrase

2) site_url: 'https://the13thletter.info/derivepassphrase/'
3) repo_url: 'https://github.com/the-13th-letter/derivepassphrase'

4) repo_name: the-13th-letter/derivepassphrase

5) site_description: An almost faithful Python reimplementation of James Coglan's vault.
6) site_author: Marco Ricci

7) copyright: Copyright © 2024 Marco Ricci (the-13th-letter)

8) 

9) remote_branch: documentation-tree
10) remote_name: '.'
11) 

12) docs_dir: docs
13) site_dir: html
14) extra_css:
15)   - mkdocstrings_recommended_styles.css
16) 
17) theme:
18)   name: "material"
19)   #font: false
20)   font:
21)     text: Noto Sans
22)     code: Noto Mono
23)     #code: Inconsolata
24)   #palette:
25)   #  - media: "(prefers-color-scheme)"
26)   #    toggle:
27)   #      icon: material/brightness-auto
28)   #      name: Switch to light mode
29)   #  - media: "(prefers-color-scheme: light)"
30)   #    scheme: default
31)   #    toggle:
32)   #      icon: material/brightness-7
33)   #      name: Switch to dark mode
34)   #  - media: "(prefers-color-scheme: dark)"
35)   #    scheme: slate
36)   #    toggle:
37)   #      icon: material/brightness-4
38)   #      name: Switch to system preference
39)   icon:
40)     logo: material/library
41)   features:

42)     - content.action.view

43)     - content.code.annotate
44)     - navigation.tracking
45)     - navigation.tabs

46)     - navigation.sections
47)     - navigation.indexes

48)     - navigation.footer

49)   custom_dir: docs-overrides

50) 
51) plugins:

52)   offline:
53)     enabled: false  # Use mkdocs_offline.yml for offline versions instead!
54)   #privacy:
55)   #  enabled: true
56)   mkdocstrings:
57)     handlers:
58)       python:
59)         import:

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'

64)         options:
65)           docstring_options:
66)             ignore_init_summary: true
67)             returns_multiple_items: false
68)           merge_init_into_class: true
69)           show_source: false
70)           heading_level: 2
71)           show_object_full_path: false
72)           show_root_members_full_path: false
73)           show_root_heading: true
74)           show_symbol_type_heading: true
75)           show_symbol_type_toc: true
76)           members_order: 'source'
77)           show_signature_annotations: true
78)           separate_signature: true

79)           signature_crossrefs: true

80)           unwrap_annotated: true

81)           scoped_crossrefs: true

82)         paths:
83)           - src

84)   mike:
85)     alias_type: symlink
86)     canonical_version: '0.x'
87)     version_selector: false

88) 
89) nav:

90)   - Overview: index.md

91)   - Tutorials & Examples:

92)     - tutorials/basic-setup-passphrase.md

93)   - How-Tos:
94)     - how-tos/ssh-key.md

95)   - Reference:

96)     - reference/index.md

97)     - 'Man page: derivepassphrase': reference/derivepassphrase.1.md

98)     - 'Man page: derivepassphrase-vault': reference/derivepassphrase-vault.1.md
99)     - 'Man page: derivepassphrase-export': reference/derivepassphrase-export.1.md
100)     - 'Man page: derivepassphrase-export-vault': reference/derivepassphrase-export-vault.1.md

101)     - Module derivepassphrase:

102)       - Submodule cli: reference/derivepassphrase.cli.md
103)       - Subpackage exporter: reference/derivepassphrase.exporter.md
104)       - Submodule sequin: reference/derivepassphrase.sequin.md
105)       - Submodule ssh_agent: reference/derivepassphrase.ssh_agent.md
106)       - Submodule _types: reference/derivepassphrase._types.md
107)       - Submodule vault: reference/derivepassphrase.vault.md

108)     - Prerequisites:
109)       - 'Using derivepassphrase vault with an SSH key': reference/prerequisites-ssh-key.md

110)   #- Design & Background: explanation.md

111)   - Changelog: changelog.md

112) exclude_docs: |
113)   changelog.d

114) not_in_nav: |
115)   _future.md

116) 
117) markdown_extensions:
118)   - abbr
119)   - attr_list
120)   - def_list
121)   - footnotes

122)   - md_in_html

123)   - admonition
124)   - smarty
125)   - toc:
126)       permalink: true

127)   - pymdownx.details

128)   - pymdownx.snippets:
129)       base_path:
130)         - 'docs'
131)         - '.'
132)       check_paths: true

133)   - pymdownx.superfences
134)   - pymdownx.tabbed:
135)       alternate_style: true