From d980babae45cf72b88beda95534dbfcb2514c45f Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Tue, 17 May 2022 15:29:06 -0700 Subject: Cleanup sphinx conf (#397) --- doc/conf.py | 178 ++++++++++-------------------------------------------------- 1 file changed, 28 insertions(+), 150 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 16e1ac3..4b36f7e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,25 +1,21 @@ +# Configuration file for the Sphinx documentation builder. # -# project-template documentation build configuration file, created by -# sphinx-quickstart on Mon Jan 18 14:44:12 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html from datetime import date -import sys -import os +import numpydoc +# -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. +import os +import sys + # for example.py sys.path.insert(0, os.path.abspath(".")) # project root @@ -27,10 +23,23 @@ sys.path.insert(0, os.path.abspath("..")) os.environ["MPLBACKEND"] = "Agg" # avoid tkinter import errors on rtfd.io -# -- General configuration --------------------------------------------------- +# -- Project information ----------------------------------------------------- -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' +project = "numpydoc" +copyright = f"2019-{date.today().year}, numpydoc maintainers" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. + +# version = .__version__ +# The full version, including alpha/beta/rc tags. +release = numpydoc.__version__ +version = numpydoc.__version__ + +# -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -50,75 +59,21 @@ extensions = [ # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] -# The suffix of source filenames. -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - # The root toctree document -master_doc = "index" # NOTE: will be changed to `root_doc` in sphinx 4 - -# General information about the project. -project = "numpydoc" -copyright = f"2019-{date.today().year}, numpydoc maintainers" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. - -import numpydoc +# master_doc = "index" # NOTE: will be changed to `root_doc` in sphinx 4 -# version = .__version__ -# The full version, including alpha/beta/rc tags. -release = numpydoc.__version__ -version = numpydoc.__version__ numpydoc_xref_param_type = True numpydoc_xref_ignore = {"optional", "type_without_description", "BadException"} # Run docstring validation as part of build process numpydoc_validation_checks = {"all", "GL01", "SA04", "RT03"} -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# 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. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -142,52 +97,6 @@ html_last_updated_fmt = "%b %d, %Y" # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = [] # ['_static'] -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - # Output file base name for HTML help builder. htmlhelp_basename = "project-templatedoc" @@ -216,38 +125,7 @@ latex_documents = [ ), ] -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - +# -- Intersphinx setup ---------------------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { -- cgit v1.2.1