Update documentation to add an auto-generated list of packages.

This commit is contained in:
Todd Gamblin
2014-10-08 03:07:54 -07:00
parent 319b37af0e
commit 36a87f5bf9
13 changed files with 133 additions and 24 deletions

View File

@@ -1,2 +1,3 @@
package_list.rst
spack*.rst
_build

View File

@@ -21,6 +21,12 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
all: html
#
# This autogenerates a package list.
#
package_list:
spack info -r > package_list.rst
#
# This creates a git repository and commits generated html docs.
# It them pushes the new branch into THIS repository as gh-pages.
@@ -69,9 +75,10 @@ help:
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -f package_list.rst
-rm -rf $(BUILDDIR)/* $(APIDOC_FILES)
html: apidoc
html: apidoc package_list
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

View File

@@ -13,7 +13,7 @@
<hr/>
<p>
&copy; Copyright 2013,
&copy; Copyright 2013-2014,
<a href="https://scalability.llnl.gov/">Lawrence Livermore National Laboratory</a>.
<br/>
Written by Todd Gamblin, <a href="mailto:tgamblin@llnl.gov">tgamblin@llnl.gov</a>, LLNL-CODE-647188

View File

@@ -90,7 +90,7 @@
# General information about the project.
project = u'Spack'
copyright = u'2013, Lawrence Livermore National Laboratory'
copyright = u'2013-2014, Lawrence Livermore National Laboratory'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the

View File

@@ -48,6 +48,7 @@ Table of Contents
packaging_guide
site_configuration
developer_guide
package_list
API Docs <spack>
Indices and tables