diff options
author | Julian Berman <Julian@GrayVines.com> | 2022-11-29 19:25:51 -0500 |
---|---|---|
committer | Julian Berman <Julian@GrayVines.com> | 2022-11-29 19:25:51 -0500 |
commit | ea1c71abbe70f426ee4667d965ab9aa2b1f07d4b (patch) | |
tree | c2268ba225ff0ea4c6541ee6a2009a0e5e76ae8d /docs/conf.py | |
parent | 1aafa19f35235bc856a35449a3f1b4dcb426219d (diff) | |
parent | 281517851c18d1ae14d40312981977a27738b2aa (diff) | |
download | jsonschema-ea1c71abbe70f426ee4667d965ab9aa2b1f07d4b.tar.gz |
Merge remote-tracking branch 'origin/main' into docs/autodoc
* origin/main:
Remove noise from the Sphinx config.
Fix instantiating validators with cached refs-to-bool schemas.
Try fixing more Sphinx refs which fail only on Ubuntu...
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 148 |
1 files changed, 42 insertions, 106 deletions
diff --git a/docs/conf.py b/docs/conf.py index 595cdf6..3f1f4a9 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", @@ -42,104 +29,18 @@ extensions = [ "sphinxext.opengraph", ] -# Add typing annotations to signatures -autodoc_typehints = "signature" - 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" - +# = Builders = -# -- Options for LaTeX output ------------------------------------------------ - -latex_documents = [ - ("index", "jsonschema.tex", "jsonschema Documentation", author, "manual"), -] - - -# -- 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,10 +53,45 @@ linkcheck_ignore = [ "https://github.com/python-jsonschema/jsonschema/workflows/CI/badge.svg", ] -# -- Options for sphinxcontrib-autosectionlabel --------------------------- +# = Extensions = + +# -- autoapi -- + +suppress_warnings = [ + "autoapi.python_import_resolution", + "autoapi.toc_reference", + "epub.duplicated_toc_entry", +] +autoapi_root = "api" +autoapi_ignore = [ + "*/_[a-z]*.py", + "*/__main__.py", + "*/benchmarks/*", + "*/cli.py", + "*/tests/*", +] +autoapi_options = [ + "members", + "undoc-members", + "show-module-summary", + "imported-members", +] + +autoapi_type = "python" +autoapi_dirs = [PACKAGE_SRC] + +# -- autosectionlabel -- autosectionlabel_prefix_document = True -# -- Options for sphinxcontrib-spelling ----------------------------------- +# -- 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 |