-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
55 lines (49 loc) · 1.19 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
site_name: Fancy Dataclass
site_author: Jeremy Silver
repo_url: https://github.com/jeremander/fancy-dataclass
edit_uri: tree/main/docs
theme:
name: material
features:
- navigation.footer
- navigation.path
extra_css:
- stylesheets/extra.css
plugins:
- mkdocstrings:
handlers:
python:
import:
- https://installer.readthedocs.io/en/stable/objects.inv
options:
filters: ["!^_[^_]", "_replace"]
- search
- gen-files:
scripts:
# see https://mkdocstrings.github.io/recipes/
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
markdown_extensions:
- admonition
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
nav:
- README.md
- Dataclass mixins: mixin.md
- JSON conversion: json.md
- TOML conversion: toml.md
- Config management: config.md
- SQL persistence: sql.md
- CLI parsing: cli.md
- Subprocess calls: subprocess.md
- Parametrized functions: func.md
# defer to gen-files + literate-nav
- Code reference: reference/
watch:
- fancy_dataclass