added mkdocs.yml
This commit is contained in:
59
mkdocs.yml
Normal file
59
mkdocs.yml
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
site_name: DocForge
|
||||||
|
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
palette:
|
||||||
|
- scheme: slate
|
||||||
|
primary: deep purple
|
||||||
|
accent: cyan
|
||||||
|
font:
|
||||||
|
text: Inter
|
||||||
|
code: JetBrains Mono
|
||||||
|
features:
|
||||||
|
- navigation.tabs
|
||||||
|
- navigation.expand
|
||||||
|
- navigation.top
|
||||||
|
- navigation.instant
|
||||||
|
- content.code.copy
|
||||||
|
- content.code.annotate
|
||||||
|
plugins:
|
||||||
|
- search
|
||||||
|
- mkdocstrings:
|
||||||
|
handlers:
|
||||||
|
python:
|
||||||
|
paths:
|
||||||
|
- .
|
||||||
|
options:
|
||||||
|
docstring_style: google
|
||||||
|
show_source: false
|
||||||
|
show_signature_annotations: true
|
||||||
|
separate_signature: true
|
||||||
|
merge_init_into_class: true
|
||||||
|
inherited_members: true
|
||||||
|
annotations_path: brief
|
||||||
|
show_root_heading: true
|
||||||
|
group_by_category: true
|
||||||
|
|
||||||
|
nav:
|
||||||
|
- Home: docforge/index.md
|
||||||
|
- Loader:
|
||||||
|
- docforge/loader/index.md
|
||||||
|
- docforge/loader/griffe_loader.md
|
||||||
|
- Model:
|
||||||
|
- docforge/model/index.md
|
||||||
|
- docforge/model/module.md
|
||||||
|
- docforge/model/object.md
|
||||||
|
- docforge/model/project.md
|
||||||
|
- Navigation:
|
||||||
|
- docforge/nav/index.md
|
||||||
|
- docforge/nav/spec.md
|
||||||
|
- docforge/nav/resolver.md
|
||||||
|
- docforge/nav/mkdocs.md
|
||||||
|
- Renderers:
|
||||||
|
- docforge/renderers/index.md
|
||||||
|
- docforge/renderers/base.md
|
||||||
|
- docforge/renderers/mkdocs.md
|
||||||
|
- CLI:
|
||||||
|
- docforge/cli/index.md
|
||||||
|
- docforge/cli/main.md
|
||||||
|
- docforge/cli/mkdocs.md
|
||||||
Reference in New Issue
Block a user