diff --git a/doc/conf.py b/doc/conf.py index d16155b4cd156001a5785176307f4cdda93633fb..ed6f89e08c18a8b75ff5c9c17a146ca43280f4d1 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,59 +1,19 @@ -# -- Path setup -------------------------------------------------------------- +from urllib.request import urlopen -# 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 -# sys.path.insert(0, os.path.abspath('.')) +_conf_url = \ + "https://raw.githubusercontent.com/inducer/sphinxconfig/main/sphinxconfig.py" +with urlopen(_conf_url) as _inf: + exec(compile(_inf.read(), _conf_url, "exec"), globals()) - -# -- Project information ----------------------------------------------------- - -project = "arraycontext" copyright = "2021, University of Illinois Board of Trustees" +author = "Arraycontext Contributors" ver_dic = {} -exec( - compile( - open("../arraycontext/version.py").read(), - "../arraycontext/version.py", "exec"), - ver_dic) +exec(compile(open("../arraycontext/version.py").read(), "../arraycontext/version.py", + "exec"), ver_dic) version = ".".join(str(x) for x in ver_dic["VERSION"]) -# The full version, including alpha/beta/rc tags. release = ver_dic["VERSION_TEXT"] -# -- General configuration --------------------------------------------------- - -# 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.doctest", - "sphinx.ext.intersphinx", - "sphinx.ext.mathjax", - "sphinx.ext.graphviz", - "sphinx_copybutton", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# 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", "Thumbs.db", ".DS_Store"] - - -# -- 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" - intersphinx_mapping = { "https://docs.python.org/3/": None, "https://numpy.org/doc/stable/": None, @@ -65,4 +25,5 @@ intersphinx_mapping = { "https://docs.pytest.org/en/latest/": None, } -autoclass_content = "class" +import sys +sys.ARRAYCONTEXT_BUILDING_SPHINX_DOCS = True