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
|
site_name: django-pgtransaction
docs_dir: docs
repo_name: AmbitionEng/django-pgtransaction
repo_url: https://github.com/AmbitionEng/django-pgtransaction
plugins:
- search
- mkdocstrings:
handlers:
python:
inventories:
- https://docs.python.org/3/objects.inv
- https://installer.readthedocs.io/en/stable/objects.inv
- https://mkdocstrings.github.io/autorefs/objects.inv
options:
docstring_options:
ignore_init_summary: true
line_length: 80
heading_level: 2
merge_init_into_class: true
separate_signature: true
show_root_heading: true
show_root_full_path: true
show_root_members_full_path: true
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
signature_crossrefs: true
markdown_extensions:
# For admonitions
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- tables
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: true
theme:
name: material
logo: static/dark_logo.png
favicon: static/light_logo.png
features:
- content.code.copy
- navigation.footer
- navigation.path
- navigation.sections
- navigation.tracking
- search.suggest
- search.highlight
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
extra_css:
- css/mkdocstrings.css
- css/mkdocs-material.css
nav:
- Overview: index.md
- Installation: installation.md
- Module: module.md
- Release Notes: release_notes.md
- Contributing Guide: contributing.md
|
