Merge "Removed a bunch of cruft files."
This commit is contained in:
3
doc/.gitignore
vendored
3
doc/.gitignore
vendored
@@ -1,3 +0,0 @@
|
|||||||
_build/*
|
|
||||||
source/api/*
|
|
||||||
.autogenerated
|
|
||||||
97
doc/Makefile
97
doc/Makefile
@@ -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."
|
|
||||||
@@ -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!
|
|
||||||
1
doc/build/.gitignore
vendored
1
doc/build/.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
*
|
|
||||||
0
doc/build/.placeholder
vendored
0
doc/build/.placeholder
vendored
0
doc/source/_static/.gitignore
vendored
0
doc/source/_static/.gitignore
vendored
0
doc/source/_templates/.gitignore
vendored
0
doc/source/_templates/.gitignore
vendored
Reference in New Issue
Block a user