summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJulian Berman <Julian@GrayVines.com>2022-11-29 19:22:58 -0500
committerJulian Berman <Julian@GrayVines.com>2022-11-29 19:22:58 -0500
commit281517851c18d1ae14d40312981977a27738b2aa (patch)
tree825fcf27289a5d3431f61c963bf143c6659e061a /docs
parentdbc398245a583cb2366795dc529ae042d10c1577 (diff)
downloadjsonschema-281517851c18d1ae14d40312981977a27738b2aa.tar.gz
Remove noise from the Sphinx config.
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py132
1 files changed, 23 insertions, 109 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 0e4bc6c..949556a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -5,29 +5,16 @@ import re
ROOT = Path(__file__).parent.parent
PACKAGE_SRC = ROOT / "jsonschema"
-# -- Project information -----------------------------------------------------
-
project = "jsonschema"
author = "Julian Berman"
copyright = "2013, " + author
-# version: The short X.Y version
-# release: The full version, including alpha/beta/rc tags.
release = importlib.metadata.version("jsonschema")
version = release.partition("-")[0]
-
-# -- General configuration ---------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = "1.0"
-
+language = "en"
default_role = "any"
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
-# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
@@ -47,99 +34,16 @@ extensions = [
cache_path = "_cache"
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = [".rst", ".md"]
-source_suffix = ".rst"
-
-# The master toctree document.
-master_doc = "index"
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ""
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = "%B %d, %Y"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "_cache", "_static", "_templates"]
-
-# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "lovelace"
pygments_dark_style = "one-dark"
-doctest_global_setup = """
-from jsonschema import *
-"""
-
-intersphinx_mapping = {
- "python": ("https://docs.python.org/3", None),
- "ujs": ("https://json-schema.org/understanding-json-schema/", None),
-}
-
-
-# -- Options for HTML output -----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
html_theme = "furo"
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ["_static"]
-
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "jsonschemadoc"
-
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_documents = [
- ("index", "jsonschema.tex", "jsonschema Documentation", author, "manual"),
-]
+# = Builders =
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [("index", "jsonschema", "jsonschema Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (
- "index",
- "jsonschema",
- "jsonschema Documentation",
- author,
- "jsonschema",
- "One line description of project.",
- "Miscellaneous",
- ),
-]
-
-# -- Options for the linkcheck builder --------------------------------------
+doctest_global_setup = """
+from jsonschema import *
+"""
def entire_domain(host):
@@ -152,15 +56,9 @@ linkcheck_ignore = [
"https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg",
]
-# -- Options for sphinxcontrib-autosectionlabel ---------------------------
+# = Extensions =
-autosectionlabel_prefix_document = True
-
-# -- Options for sphinxcontrib-spelling -----------------------------------
-
-spelling_word_list_filename = "spelling-wordlist.txt"
-
-# -- Options for autoapi ----------------------------------------------------
+# -- autoapi --
suppress_warnings = [
"autoapi.python_import_resolution",
@@ -184,3 +82,19 @@ autoapi_options = [
autoapi_type = "python"
autoapi_dirs = [PACKAGE_SRC]
+
+# -- autosectionlabel --
+
+autosectionlabel_prefix_document = True
+
+# -- intersphinx --
+
+intersphinx_mapping = {
+ "python": ("https://docs.python.org/3", None),
+ "ujs": ("https://json-schema.org/understanding-json-schema/", None),
+}
+
+# -- sphinxcontrib-spelling --
+
+spelling_word_list_filename = "spelling-wordlist.txt"
+spelling_show_suggestions = True