-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
80 lines (74 loc) · 2.21 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
site_name: YASF
site_description: Yet Another Scattering Framework
site_url: https://agbv.github.io/yasf
repo_url: https://github.com/AGBV/YASF
nav:
- Home: index.md
- Code Reference: reference/
- Testing:
- testing/index.md
- coverage.md
- TODO: todo_gen.md
theme:
name: "material"
logo: "assets/img/logo_white.svg"
favicon: "assets/img/logo_white.svg"
features:
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- toc.integrate
custom_dir: docs/overrides
plugins:
- autorefs:
- coverage:
page_name: coverage
html_report_dir: htmlcov
- search:
lang: en
- gen-files:
scripts:
- scripts/gen_ref_pages.py
- scripts/gen_todo.py
- literate-nav:
nav_file: summary.md
- section-index
- mkdocstrings:
default_handler: python
handlers:
python:
paths:
- yasfpy
hide:
- instance-attribute
options:
# General options: various options that do not fit in the other categories
show_bases: true
show_source: true
# Headings options: options related to headings and the table of contents (or sidebar, depending on the theme used)
show_root_full_path: false
# Members options: options related to filtering or ordering members in the generated documentation
members_order: source
summary: false
# Docstrings options: options related to docstrings (parsing and rendering)
docstring_style: google
docstring_section_style: table
merge_init_into_class: true
show_if_no_docstring: true
# Signature options: options related to signatures and type annotations
show_signature: false
separate_signature: false
# heading_level: 2
markdown_extensions:
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.tasklist:
custom_checkbox: true
extra_css:
- css/mkdocstrings.css
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js