-
Notifications
You must be signed in to change notification settings - Fork 8
/
mkdocs.yml
95 lines (94 loc) · 2.87 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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
docs_dir: docs-mkdocs
repo_name: rcsb/py-mmcif
repo_url: https://github.com/rcsb/py-mmcif
site_description: mmCIF Core Access Library
site_name: mmCIF Core Access Library
site_url: https://github.com/rcsb/py-mmcif
#
#extra_css:
# - static/css/mkdocstrings.css
markdown_extensions:
- markdown_include.include
- pymdownx.magiclink
#- toc:
# permalink: "\xA4"
#
- admonition # alerts
- pymdownx.details # collapsible alerts
- pymdownx.superfences # nest code and content inside alerts
- attr_list # add HTML and CSS to Markdown elements
- pymdownx.inlinehilite # inline code highlights
- pymdownx.keys # show keystroke symbols
- pymdownx.snippets # insert content from other files
- pymdownx.tabbed # content tabs
- footnotes
- def_list
- pymdownx.arithmatex: # mathjax
generic: true
- pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: true
- codehilite
- pymdownx.highlight:
use_pygments: true
- toc:
toc_depth: 4
plugins:
- search
- mkdocstrings:
handlers:
python:
rendering:
group_by_category: true
show_category_heading: true
show_if_no_docstring: true
show_root_heading: true
selection:
filters:
- "!^_[^_]"
- "!^__json"
- "!^__config__"
watch:
- mmcif
theme:
name: material
#logo: static/images/rcsb_logo.png
favicon: static/images/favicon.ico
palette:
accent: grey
primary: blue grey
scheme: default
font:
text: Roboto
code: Roboto Mono
features:
- navigation.tabs
- navigation.expand
icon:
repo: fontawesome/brands/github
# ---- ----
nav:
- Overview: index.md
- Reference:
- Overview: api_reference.md
- API:
- DataCategory: api_reference/DataCategory.md
- DataCategoryBase: api_reference/DataCategoryBase.md
- DataCategoryFormatted: api_reference/DataCategoryFormatted.md
- DataCategoryTyped: api_reference/DataCategoryTyped.md
- DictMethodRunner: api_reference/DictMethodRunner.md
- DictionaryApi: api_reference/DictionaryApi.md
- DictionaryInclude: api_reference/DictionaryInclude.md
- Method: api_reference/Method.md
- MethodUtils: api_reference/MethodUtils.md
- PdbxContainers: api_reference/PdbxContainers.md
- IO:
- BinaryCifReader: api_reference/BinaryCifReader.md
- BinaryCifWriter: api_reference/BinaryCifWriter.md
- CifFile: api_reference/CifFile.md
- IoAdapterBase: api_reference/IoAdapterBase.md
- IoAdapterCore: api_reference/IoAdapterCore.md
- IoAdapterPy: api_reference/IoAdapterPy.md
- PdbxExceptions: api_reference/PdbxExceptions.md
- PdbxReader: api_reference/PdbxReader.md
- PdbxWriter: api_reference/PdbxWriter.md