Move sphinx-apidoc into conf.py, too.
This commit is contained in:
parent
32834dd67d
commit
3a9388b43a
1
lib/spack/docs/.gitignore
vendored
1
lib/spack/docs/.gitignore
vendored
@ -1,4 +1,5 @@
|
|||||||
package_list.rst
|
package_list.rst
|
||||||
command_index.rst
|
command_index.rst
|
||||||
spack*.rst
|
spack*.rst
|
||||||
|
modules.rst
|
||||||
_build
|
_build
|
||||||
|
@ -74,7 +74,7 @@ clean:
|
|||||||
-rm -f package_list.rst command_index.rst
|
-rm -f package_list.rst command_index.rst
|
||||||
-rm -rf $(BUILDDIR)/* $(APIDOC_FILES)
|
-rm -rf $(BUILDDIR)/* $(APIDOC_FILES)
|
||||||
|
|
||||||
html: apidoc
|
html:
|
||||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
@echo
|
@echo
|
||||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
@ -42,6 +42,7 @@
|
|||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
from glob import glob
|
from glob import glob
|
||||||
|
from sphinx.apidoc import main as sphinx_apidoc
|
||||||
|
|
||||||
# -- Spack customizations -----------------------------------------------------
|
# -- Spack customizations -----------------------------------------------------
|
||||||
|
|
||||||
@ -93,6 +94,10 @@
|
|||||||
for cmd in sorted(command_names):
|
for cmd in sorted(command_names):
|
||||||
index.write(' * :ref:`%s`\n' % cmd)
|
index.write(' * :ref:`%s`\n' % cmd)
|
||||||
|
|
||||||
|
|
||||||
|
# Run sphinx-apidoc
|
||||||
|
sphinx_apidoc(['-T', '-o', '.', '../spack'])
|
||||||
|
|
||||||
#
|
#
|
||||||
# Exclude everything in spack.__all__ from indexing. All of these
|
# Exclude everything in spack.__all__ from indexing. All of these
|
||||||
# symbols are imported from elsewhere in spack; their inclusion in
|
# symbols are imported from elsewhere in spack; their inclusion in
|
||||||
|
Loading…
Reference in New Issue
Block a user