-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
42 lines (38 loc) · 1.27 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
site_name: LayerForge
repo_url: https://github.com/ravenoak/layerforge
theme:
# https://mkdocstrings.github.io/usage/theming/
name: "material" # https://squidfunk.github.io/mkdocs-material/getting-started/
nav:
- Home: index.md
- "Getting Started": getting_started.md
- Features: features.md
- Configuration: configuration.md
- Development: development.md
- "Technologies Used": technologies_used.md
- Reference:
- "CLI Reference": cli_reference.md
- "API Reference": api_reference/
markdown_extensions:
- attr_list
- mkdocs-click # https://github.com/mkdocs/mkdocs-click?tab=readme-ov-file
plugins:
- search
- gen-files:
# https://github.com/oprypin/mkdocs-gen-files
scripts:
- scripts/gen_ref_pages.py # https://mkdocstrings.github.io/recipes/#generate-pages-on-the-fly
- include-markdown # https://github.com/mondeja/mkdocs-include-markdown-plugin
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
# https://mkdocstrings.github.io/usage/
default_handler: python
handlers:
python:
# https://mkdocstrings.github.io/python/
options:
docstring_style: numpy
docstring_options:
ignore_init_summary: true
merge_init_into_class: true