-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
129 lines (118 loc) · 3.15 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# See
# https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml
# for ideas.
# Project information
site_name: "refcount - Python package for reference counting"
# site_url: https://squidfunk.github.io/mkdocs-material/
site_author: "Jean-Michel Perraud"
site_description: >-
This package is primarily for managing resources, for instance from
native libraries written for instance in C++, from Python.
# Repository
repo_name: csiro-hydroinformatics/pyrefcount
repo_url: https://github.com/csiro-hydroinformatics/pyrefcount
docs_dir: './docs'
# Copyright
copyright: Copyright © 2016 - 2022 CSIRO
theme:
# name: "readthedocs"
name: "material"
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode # Default values, taken from mkdocs_theme.yml
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
language: en
features:
- content.code.annotate
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.indexes
# - navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
plugins:
- search
- mkdocstrings:
handlers:
# See: https://mkdocstrings.github.io/python/usage/
python:
options:
docstring_style: google
# minify seems advanced. https://squidfunk.github.io/mkdocs-material/customization/#theme-development
# - minify:
# minify_html: true
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
# - pymdownx.emoji:
# emoji_generator: !!python/name:materialx.emoji.to_svg
# emoji_index: !!python/name:materialx.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# class: mermaid
# format: !!python/name:pymdownx.superfences.fence_code_format
# - pymdownx.keys
# - pymdownx.magiclink:
# repo_url_shorthand: true
# user: csiro-hydroinformatics
# repo: pyrefcount
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
nav:
- Home: index.md
- Applications: usage-and-applications.md
- API Doc:
- Submodule interop: interop-module.md
- Submodule putils: putils-module.md
- Submodule base: base-module.md
- Appendix:
- Developer Notes: tech_notes.md
# - Sandpit: sandpit.md