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
|
"""sphinx configuration."""
from immutabledict import __version__
# Project info
project = "immutabledict"
copyright = "2023, corenting"
author = "corenting"
version = __version__
release = __version__
# General configuration
extensions = [
"alabaster",
"sphinx.ext.intersphinx",
"sphinx.ext.autodoc",
"myst_parser",
]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# Autodoc settings
autodoc_default_options = {
"members": True,
}
# intersphinx to Python
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
# HTML output
html_theme = "alabaster"
html_sidebars = {
"**": [
"about.html",
"navigation.html",
"relations.html",
"searchbox.html",
"donate.html",
]
}
html_theme_options = {
"description": "An immutable wrapper around dictionaries",
"github_user": "corenting",
"github_repo": "immutabledict",
"github_type": "star",
"codecov_button": True,
"badge_branch": "master",
"sidebar_width": "300px",
"donate_url": "https://corenting.fr/donate",
"extra_nav_links": {
"Github repository": "https://github.com/corenting/immutabledict",
"PyPI page": "https://pypi.org/project/immutabledict/",
},
}
|
