zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix Sphinx deprecation warning when building docs (#12205)

Browse Source 
* Fix Sphinx deprecation warning when building docs

* Set minimum required version of Sphinx
This commit is contained in:
Adam J. Stewart 2019-07-31 03:23:56 -05:00 committed by Massimiliano Culpo
parent 86ff5baed7
commit d973fca00e
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/spack/docs/conf.py
View File

@ -68,7 +68,6 @@
# Without this, the API Docs will never actually update # Without this, the API Docs will never actually update
# #
apidoc_args = [ apidoc_args = [
'--force', # Older versions of Sphinx ignore the first argument
'--force', # Overwrite existing files '--force', # Overwrite existing files
'--no-toc', # Don't create a table of contents file '--no-toc', # Don't create a table of contents file
'--output-dir=.', # Directory to place all output '--output-dir=.', # Directory to place all output
@ -91,12 +90,12 @@ def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
env, fromdocname, builder, typ, target, node, contnode) env, fromdocname, builder, typ, target, node, contnode)
def setup(sphinx): def setup(sphinx):
sphinx.override_domain(PatchedPythonDomain) sphinx.add_domain(PatchedPythonDomain, override=True)
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0' needs_sphinx = '1.8'
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.