From 1527c099bc6baae6773902b3d190fac6ed691328 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Fri, 25 Jun 2021 13:44:23 -0500 Subject: [PATCH] Use downloaded shared sphinxconfig --- doc/conf.py | 118 +++------------------------------------------------- 1 file changed, 6 insertions(+), 112 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 9b08ace0..4cc5f774 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,34 +1,14 @@ -# General configuration -# --------------------- +from urllib.request import urlopen -# 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.intersphinx", - "sphinx.ext.autodoc", - "sphinx.ext.doctest", - "sphinx_copybutton", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +_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()) exclude_patterns = ["subst.rst"] -# The suffix of source filenames. -source_suffix = ".rst" - -# The master toctree document. -master_doc = "index" +copyright = "2009-21, Andreas Kloeckner" -# General substitutions. -project = "PyOpenCL" -copyright = "2009, Andreas Kloeckner" - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. ver_dic = {} with open("../pyopencl/version.py") as ver_file: ver_src = ver_file.read() @@ -37,94 +17,8 @@ version = ".".join(str(x) for x in ver_dic["VERSION"]) # The full version, including alpha/beta/rc tags. release = ver_dic["VERSION_TEXT"] -# 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 documents that shouldn't be included in the build. -# unused_docs = [] - -# List of directories, relative to source directories, that shouldn't be searched -# for source files. -# exclude_dirs = [] - -# 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 - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - - -# Options for HTML output -# ----------------------- - -html_theme = "furo" - -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -# html_style = 'default.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# The name of an image file (within the static path) to place at the top of -# the sidebar. -# html_logo = None - -# 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'] - -# 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_use_modindex = True - -# If true, the reST sources are included in the HTML build as _sources/. -html_copy_source = False - -# 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 = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = "PyOpenClDoc" - - intersphinx_mapping = { "https://docs.python.org/dev": None, "https://numpy.org/doc/stable/": None, "https://docs.makotemplates.org/en/latest/": None, } - -autoclass_content = "class" -- GitLab