-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
60 lines (56 loc) · 1.51 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
site_name: Pyreball
theme:
name: material
features:
- content.code.copy
palette:
- scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
repo_name: karelvaculik/pyreball
repo_url: https://github.com/karelvaculik/pyreball
plugins:
- search
- macros:
module_name: docs/plugins/main
- mkdocstrings:
handlers:
python:
paths: [ . ]
options:
members_order: alphabetical
separate_signature: true
filters: [ "!^_", "!print_html", "__str__", "__call__" ]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
show_source: false
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- admonition
- pymdownx.details
nav:
- Get Started: index.md
- Usage:
- Basic Printing: basic_printing.md
- Text Utils: text_utils.md
- Tables: tables.md
- Code Blocks: code_blocks.md
- Plotting: plotting.md
- References: references.md
- Custom Building Blocks: custom_functions.md
- Configuration and CLI Arguments: configuration.md
- API Documentation:
- pyreball.html: api/pyreball_html.md
- pyreball.text: api/pyreball_text.md