Skip to content

Commit d973fca

Browse files
adamjstewartalalazo
authored andcommitted
Fix Sphinx deprecation warning when building docs (spack#12205)
* Fix Sphinx deprecation warning when building docs * Set minimum required version of Sphinx
1 parent 86ff5ba commit d973fca

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

lib/spack/docs/conf.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@
6868
# Without this, the API Docs will never actually update
6969
#
7070
apidoc_args = [
71-
'--force', # Older versions of Sphinx ignore the first argument
7271
'--force', # Overwrite existing files
7372
'--no-toc', # Don't create a table of contents file
7473
'--output-dir=.', # Directory to place all output
@@ -91,12 +90,12 @@ def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
9190
env, fromdocname, builder, typ, target, node, contnode)
9291

9392
def setup(sphinx):
94-
sphinx.override_domain(PatchedPythonDomain)
93+
sphinx.add_domain(PatchedPythonDomain, override=True)
9594

9695
# -- General configuration -----------------------------------------------------
9796

9897
# If your documentation needs a minimal Sphinx version, state it here.
99-
#needs_sphinx = '1.0'
98+
needs_sphinx = '1.8'
10099

101100
# Add any Sphinx extension module names here, as strings. They can be extensions
102101
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

0 commit comments

Comments
 (0)