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
|
import importlib.metadata
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autodoc.typehints",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx_copybutton",
"sphinx_design",
"sphinx_issues",
"sphinxext.opengraph",
]
primary_domain = "py"
default_role = "py:obj"
intersphinx_mapping = {
"python": ("/usr/share/doc/python3-doc/html", None),
"marshmallow": ("/usr/share/doc/python3-marshmallow/html", None),
"sqlalchemy": ("/usr/share/doc/python-sqlalchemy-doc/html", None),
}
issues_github_path = "marshmallow-code/marshmallow-sqlalchemy"
source_suffix = ".rst"
master_doc = "index"
project = "marshmallow-sqlalchemy"
copyright = "Steven Loria and contributors" # noqa: A001
version = release = importlib.metadata.version("marshmallow-sqlalchemy")
exclude_patterns = ["_build"]
# THEME
html_theme = "furo"
html_logo = "_static/marshmallow-sqlalchemy-logo.png"
html_theme_options = {
"source_repository": "https://github.com/marshmallow-code/marshmallow-sqlalchemy",
"source_branch": "dev",
"source_directory": "docs/",
"sidebar_hide_name": True,
"light_css_variables": {
# Serif system font stack: https://systemfontstack.com/
"font-stack": "Iowan Old Style, Apple Garamond, Baskerville, Times New Roman, Droid Serif, Times, Source Serif Pro, serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;",
},
"top_of_page_buttons": ["view"],
}
pygments_dark_style = "lightbulb"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_show_sourcelink = False
ogp_image = "_static/marshmallow-sqlalchemy-logo.png"
# Strip the dollar prompt when copying code
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#strip-and-configure-input-prompts-for-code-cells
copybutton_prompt_text = "$ "
autodoc_typehints = "description"
autodoc_member_order = "bysource"
|
