File: conf.py

package info (click to toggle)
python-flask-marshmallow 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 340 kB
  • sloc: python: 1,110; makefile: 169; sh: 17
file content (50 lines) | stat: -rwxr-xr-x 1,591 bytes parent folder | download | duplicates (2)
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
import importlib.metadata
import os
import sys

sys.path.append(os.path.abspath("_themes"))
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx_issues"]

intersphinx_mapping = {
    "python": ("/usr/share/doc/python3-doc/html", None),
    "flask": ("/usr/share/doc/python-flask-doc/html", None),
    "flask-sqlalchemy": ("/usr/share/doc/flask-sqlalchemy-doc/html", None),
    "marshmallow": ("/usr/share/doc/python3-marshmallow/html", None),
# There is no -doc package yet for marshmallow-sqlalchemy.
#    "marshmallow-sqlalchemy": (
#        "http://marshmallow-sqlalchemy.readthedocs.io/en/latest/",
#        None,
#    ),
}

primary_domain = "py"
default_role = "py:obj"

issues_github_path = "marshmallow-code/flask-marshmallow"

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = ".rst"
# The master toctree document.
master_doc = "index"

# General information about the project.
project = "Flask-Marshmallow"
copyright = "Steven Loria and contributors"


version = release = importlib.metadata.version("flask-marshmallow")
exclude_patterns = ["_build"]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "flask_theme_support.FlaskyStyle"
html_theme = "flask_small"
html_theme_path = ["_themes"]
html_static_path = ["_static"]
html_sidebars = {
    "index": ["side-primary.html", "searchbox.html"],
    "**": ["side-secondary.html", "localtoc.html", "relations.html", "searchbox.html"],
}

htmlhelp_basename = "flask-marshmallowdoc"