Skip to content

Commit 2815178

Browse files
committed
Remove noise from the Sphinx config.
1 parent dbc3982 commit 2815178

File tree

1 file changed

+23
-109
lines changed

1 file changed

+23
-109
lines changed

docs/conf.py

Lines changed: 23 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,16 @@
55
ROOT = Path(__file__).parent.parent
66
PACKAGE_SRC = ROOT / "jsonschema"
77

8-
# -- Project information -----------------------------------------------------
9-
108
project = "jsonschema"
119
author = "Julian Berman"
1210
copyright = "2013, " + author
1311

14-
# version: The short X.Y version
15-
# release: The full version, including alpha/beta/rc tags.
1612
release = importlib.metadata.version("jsonschema")
1713
version = release.partition("-")[0]
1814

19-
20-
# -- General configuration ---------------------------------------------------
21-
22-
# If your documentation needs a minimal Sphinx version, state it here.
23-
#
24-
# needs_sphinx = "1.0"
25-
15+
language = "en"
2616
default_role = "any"
2717

28-
# Add any Sphinx extension module names here, as strings. They can be
29-
# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
30-
# ones.
3118
extensions = [
3219
"sphinx.ext.autodoc",
3320
"sphinx.ext.autosectionlabel",
@@ -47,99 +34,16 @@
4734

4835
cache_path = "_cache"
4936

50-
# Add any paths that contain templates here, relative to this directory.
51-
templates_path = ["_templates"]
52-
53-
# The suffix(es) of source filenames.
54-
# You can specify multiple suffix as a list of string:
55-
#
56-
# source_suffix = [".rst", ".md"]
57-
source_suffix = ".rst"
58-
59-
# The master toctree document.
60-
master_doc = "index"
61-
62-
# There are two options for replacing |today|: either, you set today to some
63-
# non-false value, then it is used:
64-
# today = ""
65-
# Else, today_fmt is used as the format for a strftime call.
66-
# today_fmt = "%B %d, %Y"
67-
68-
# List of patterns, relative to source directory, that match files and
69-
# directories to ignore when looking for source files.
70-
# This pattern also affects html_static_path and html_extra_path.
71-
exclude_patterns = ["_build", "_cache", "_static", "_templates"]
72-
73-
# The name of the Pygments (syntax highlighting) style to use.
7437
pygments_style = "lovelace"
7538
pygments_dark_style = "one-dark"
7639

77-
doctest_global_setup = """
78-
from jsonschema import *
79-
"""
80-
81-
intersphinx_mapping = {
82-
"python": ("https://docs.python.org/3", None),
83-
"ujs": ("https://json-schema.org/understanding-json-schema/", None),
84-
}
85-
86-
87-
# -- Options for HTML output -----------------------------------------------
88-
89-
# The theme to use for HTML and HTML Help pages. See the documentation for
90-
# a list of builtin themes.
9140
html_theme = "furo"
9241

93-
# Theme options are theme-specific and customize the look and feel of a theme
94-
# further. For a list of options available for each theme, see the
95-
# documentation.
96-
#
97-
# html_theme_options = {}
98-
99-
# Add any paths that contain custom static files (such as style sheets) here,
100-
# relative to this directory. They are copied after the builtin static files,
101-
# so a file named "default.css" will overwrite the builtin "default.css".
102-
# html_static_path = ["_static"]
103-
104-
105-
# -- Options for HTMLHelp output ---------------------------------------------
106-
107-
# Output file base name for HTML help builder.
108-
htmlhelp_basename = "jsonschemadoc"
109-
110-
111-
# -- Options for LaTeX output ------------------------------------------------
112-
113-
latex_documents = [
114-
("index", "jsonschema.tex", "jsonschema Documentation", author, "manual"),
115-
]
42+
# = Builders =
11643

117-
118-
# -- Options for manual page output ------------------------------------------
119-
120-
# One entry per manual page. List of tuples
121-
# (source start file, name, description, authors, manual section).
122-
man_pages = [("index", "jsonschema", "jsonschema Documentation", [author], 1)]
123-
124-
125-
# -- Options for Texinfo output ----------------------------------------------
126-
127-
# Grouping the document tree into Texinfo files. List of tuples
128-
# (source start file, target name, title, author,
129-
# dir menu entry, description, category)
130-
texinfo_documents = [
131-
(
132-
"index",
133-
"jsonschema",
134-
"jsonschema Documentation",
135-
author,
136-
"jsonschema",
137-
"One line description of project.",
138-
"Miscellaneous",
139-
),
140-
]
141-
142-
# -- Options for the linkcheck builder --------------------------------------
44+
doctest_global_setup = """
45+
from jsonschema import *
46+
"""
14347

14448

14549
def entire_domain(host):
@@ -152,15 +56,9 @@ def entire_domain(host):
15256
"https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg",
15357
]
15458

155-
# -- Options for sphinxcontrib-autosectionlabel ---------------------------
59+
# = Extensions =
15660

157-
autosectionlabel_prefix_document = True
158-
159-
# -- Options for sphinxcontrib-spelling -----------------------------------
160-
161-
spelling_word_list_filename = "spelling-wordlist.txt"
162-
163-
# -- Options for autoapi ----------------------------------------------------
61+
# -- autoapi --
16462

16563
suppress_warnings = [
16664
"autoapi.python_import_resolution",
@@ -184,3 +82,19 @@ def entire_domain(host):
18482

18583
autoapi_type = "python"
18684
autoapi_dirs = [PACKAGE_SRC]
85+
86+
# -- autosectionlabel --
87+
88+
autosectionlabel_prefix_document = True
89+
90+
# -- intersphinx --
91+
92+
intersphinx_mapping = {
93+
"python": ("https://docs.python.org/3", None),
94+
"ujs": ("https://json-schema.org/understanding-json-schema/", None),
95+
}
96+
97+
# -- sphinxcontrib-spelling --
98+
99+
spelling_word_list_filename = "spelling-wordlist.txt"
100+
spelling_show_suggestions = True

0 commit comments

Comments
 (0)