diff options
author | Jenkins <jenkins@review.openstack.org> | 2012-07-11 05:13:27 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2012-07-11 05:13:27 +0000 |
commit | 4e251fec893821697080c7b65748a337b61e47e2 (patch) | |
tree | 2127e2730b81acb0070b76966ca02550ec6cceec | |
parent | 523277cbdf87ba855d7fe97171ed6acd2c8ddc2f (diff) | |
parent | c586de1c5826a5e132feeea94a7428f37b2c3238 (diff) | |
download | nova-4e251fec893821697080c7b65748a337b61e47e2.tar.gz nova-4e251fec893821697080c7b65748a337b61e47e2.tar.xz nova-4e251fec893821697080c7b65748a337b61e47e2.zip |
Merge "Removed a bunch of cruft files."
-rw-r--r-- | doc/.gitignore | 3 | ||||
-rw-r--r-- | doc/Makefile | 97 | ||||
-rw-r--r-- | doc/README.rst | 55 | ||||
-rw-r--r-- | doc/build/.gitignore | 1 | ||||
-rw-r--r-- | doc/build/.placeholder | 0 | ||||
-rw-r--r-- | doc/source/_static/.gitignore | 0 | ||||
-rw-r--r-- | doc/source/_static/.placeholder | 0 | ||||
-rw-r--r-- | doc/source/_templates/.gitignore | 0 | ||||
-rw-r--r-- | doc/source/_templates/.placeholder | 0 |
9 files changed, 0 insertions, 156 deletions
diff --git a/doc/.gitignore b/doc/.gitignore deleted file mode 100644 index 291b04e45..000000000 --- a/doc/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -_build/* -source/api/* -.autogenerated diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 251a008e0..000000000 --- a/doc/Makefile +++ /dev/null @@ -1,97 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXSOURCE = source -PAPER = -BUILDDIR = build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SPHINXSOURCE) - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -.DEFAULT_GOAL = html - -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - -rm -rf nova.sqlite - if [ -f .autogenerated ] ; then \ - cat .autogenerated | xargs rm ; \ - rm .autogenerated ; \ - fi - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nova.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nova.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/doc/README.rst b/doc/README.rst deleted file mode 100644 index 7e5229a1a..000000000 --- a/doc/README.rst +++ /dev/null @@ -1,55 +0,0 @@ -================= -Building the docs -================= - -Dependencies -============ - -Sphinx_ - You'll need sphinx (the python one) and if you are - using the virtualenv you'll need to install it in the virtualenv - specifically so that it can load the nova modules. - - :: - - pip install Sphinx - -Graphviz_ - Some of the diagrams are generated using the ``dot`` language - from Graphviz. - - :: - - sudo apt-get install graphviz - -.. _Sphinx: http://sphinx.pocoo.org - -.. _Graphviz: http://www.graphviz.org/ - - -Use `make` -========== - -Just type make:: - - % make - -Look in the Makefile for more targets. - - -Manually -======== - - 1. Generate the code.rst file so that Sphinx will pull in our docstrings:: - - % ./generate_autodoc_index.sh > source/code.rst - - 2. Run `sphinx_build`:: - - % sphinx-build -b html source build/html - - -The docs have been built -======================== - -Check out the `build` directory to find them. Yay! diff --git a/doc/build/.gitignore b/doc/build/.gitignore deleted file mode 100644 index 72e8ffc0d..000000000 --- a/doc/build/.gitignore +++ /dev/null @@ -1 +0,0 @@ -* diff --git a/doc/build/.placeholder b/doc/build/.placeholder deleted file mode 100644 index e69de29bb..000000000 --- a/doc/build/.placeholder +++ /dev/null diff --git a/doc/source/_static/.gitignore b/doc/source/_static/.gitignore deleted file mode 100644 index e69de29bb..000000000 --- a/doc/source/_static/.gitignore +++ /dev/null diff --git a/doc/source/_static/.placeholder b/doc/source/_static/.placeholder deleted file mode 100644 index e69de29bb..000000000 --- a/doc/source/_static/.placeholder +++ /dev/null diff --git a/doc/source/_templates/.gitignore b/doc/source/_templates/.gitignore deleted file mode 100644 index e69de29bb..000000000 --- a/doc/source/_templates/.gitignore +++ /dev/null diff --git a/doc/source/_templates/.placeholder b/doc/source/_templates/.placeholder deleted file mode 100644 index e69de29bb..000000000 --- a/doc/source/_templates/.placeholder +++ /dev/null |