Skip to content

Commit e6e7ff4

Browse files
mboersmamboersma
committed
Updated sphinx docs layout.
1 parent 8db1ff1 commit e6e7ff4

30 files changed

Lines changed: 483 additions & 210 deletions

‎docs/.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
build/
1+
_build/

‎docs/Makefile‎

Lines changed: 51 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Makefile for Deis documentation
1+
# Makefile for Sphinx documentation
22
#
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
88
PYTHON = python
9-
BUILDDIR = build
9+
BUILDDIR = _build
1010

1111
# User-friendly check for sphinx-build
1212
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@@ -16,50 +16,40 @@ endif
1616
# Internal variables.
1717
PAPEROPT_a4 = -D latex_paper_size=a4
1818
PAPEROPT_letter = -D latex_paper_size=letter
19-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
2020
# the i18n builder cannot share the environment and doctrees with the others
21-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
2222

2323
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
2424

25-
docs:
26-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
27-
@echo
28-
@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."
29-
3025
help:
3126
@echo "Please use \`make <target>' where <target> is one of"
32-
# @echo " html to make standalone HTML files"
33-
# @echo " dirhtml to make HTML files named index.html in directories"
34-
# @echo " singlehtml to make a single large HTML file"
35-
# @echo " pickle to make pickle files"
36-
# @echo " json to make JSON files"
37-
# @echo " htmlhelp to make HTML files and a HTML help project"
38-
# @echo " qthelp to make HTML files and a qthelp project"
39-
# @echo " devhelp to make HTML files and a Devhelp project"
40-
# @echo " epub to make an epub"
41-
# @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
42-
# @echo " latexpdf to make LaTeX files and run them through pdflatex"
43-
# @echo " text to make text files"
44-
# @echo " man to make manual pages"
45-
# @echo " texinfo to make Texinfo files"
46-
# @echo " info to make Texinfo files and run them through makeinfo"
47-
# @echo " gettext to make PO message catalogs"
48-
# @echo " changes to make an overview of all changed/added/deprecated items"
49-
# @echo " linkcheck to check all external links for integrity"
50-
# @echo " doctest to run all doctests embedded in the documentation (if enabled)"
51-
@echo " docs to build the docs and copy the static files to the outputdir"
52-
@echo " server to serve the docs in your browser under \`http://localhost:8000\`"
53-
@echo " publish to publish the app to deis.io"
54-
55-
publish:
56-
@echo "Coming soon..."
57-
58-
server: docs
59-
@cd $(BUILDDIR)/html; $(PYTHON) -m SimpleHTTPServer 8000
27+
@echo " html to make standalone HTML files"
28+
@echo " dirhtml to make HTML files named index.html in directories"
29+
@echo " server to make dirhtml as above, then serve it at http://0.0.0.0:8000/"
30+
@echo " singlehtml to make a single large HTML file"
31+
@echo " pickle to make pickle files"
32+
@echo " json to make JSON files"
33+
@echo " htmlhelp to make HTML files and a HTML help project"
34+
@echo " qthelp to make HTML files and a qthelp project"
35+
@echo " devhelp to make HTML files and a Devhelp project"
36+
@echo " epub to make an epub"
37+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
38+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
39+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
40+
@echo " text to make text files"
41+
@echo " man to make manual pages"
42+
@echo " texinfo to make Texinfo files"
43+
@echo " info to make Texinfo files and run them through makeinfo"
44+
@echo " gettext to make PO message catalogs"
45+
@echo " changes to make an overview of all changed/added/deprecated items"
46+
@echo " xml to make Docutils-native XML files"
47+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
48+
@echo " linkcheck to check all external links for integrity"
49+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
6050

6151
clean:
62-
rm -rf $(BUILDDIR)
52+
rm -rf $(BUILDDIR)/*
6353

6454
html:
6555
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -97,17 +87,17 @@ qthelp:
9787
@echo
9888
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
9989
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
100-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Docker.qhcp"
90+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/deis.qhcp"
10191
@echo "To view the help file:"
102-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Docker.qhc"
92+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/deis.qhc"
10393

10494
devhelp:
10595
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
10696
@echo
10797
@echo "Build finished."
10898
@echo "To view the help file:"
109-
@echo "# mkdir -p $$HOME/.local/share/devhelp/Docker"
110-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Docker"
99+
@echo "# mkdir -p $$HOME/.local/share/devhelp/deis"
100+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/deis"
111101
@echo "# devhelp"
112102

113103
epub:
@@ -128,6 +118,12 @@ latexpdf:
128118
$(MAKE) -C $(BUILDDIR)/latex all-pdf
129119
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
130120

121+
latexpdfja:
122+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
123+
@echo "Running LaTeX files through platex and dvipdfmx..."
124+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
125+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
126+
131127
text:
132128
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
133129
@echo
@@ -171,3 +167,16 @@ doctest:
171167
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
172168
@echo "Testing of doctests in the sources finished, look at the " \
173169
"results in $(BUILDDIR)/doctest/output.txt."
170+
171+
xml:
172+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
173+
@echo
174+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
175+
176+
pseudoxml:
177+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
178+
@echo
179+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
180+
181+
server: dirhtml
182+
@cd $(BUILDDIR)/dirhtml; $(PYTHON) -m SimpleHTTPServer 8000

‎docs/_static‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../web/static/

docs/source/_static/.gitignore renamed to docs/_templates/.gitignore

File renamed without changes.

‎docs/api/api.management.commands.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
commands Package
2+
================
3+
4+
:mod:`client` Module
5+
--------------------
6+
7+
.. automodule:: api.management.commands.client
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:

‎docs/api/api.management.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
management Package
2+
==================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
9+
api.management.commands

‎docs/api/api.migrations.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
migrations Package
2+
==================
3+
4+
:mod:`0001_initial` Module
5+
--------------------------
6+
7+
.. automodule:: api.migrations.0001_initial
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
:mod:`0002_auto__del_field_build_version__del_unique_build_version_formation` Module
13+
------------------------------------------------------------------------------------
14+
15+
.. automodule:: api.migrations.0002_auto__del_field_build_version__del_unique_build_version_formation
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
:mod:`0003_auto__del_access__del_event` Module
21+
----------------------------------------------
22+
23+
.. automodule:: api.migrations.0003_auto__del_access__del_event
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

‎docs/api/api.tests.rst‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
tests Package
2+
=============
3+
4+
:mod:`tests` Package
5+
--------------------
6+
7+
.. automodule:: api.tests
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
:mod:`auth` Module
13+
------------------
14+
15+
.. automodule:: api.tests.auth
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
:mod:`build` Module
21+
-------------------
22+
23+
.. automodule:: api.tests.build
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
:mod:`config` Module
29+
--------------------
30+
31+
.. automodule:: api.tests.config
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
:mod:`container` Module
37+
-----------------------
38+
39+
.. automodule:: api.tests.container
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
:mod:`flavor` Module
45+
--------------------
46+
47+
.. automodule:: api.tests.flavor
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
:mod:`formation` Module
53+
-----------------------
54+
55+
.. automodule:: api.tests.formation
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
:mod:`key` Module
61+
-----------------
62+
63+
.. automodule:: api.tests.key
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
:mod:`layer` Module
69+
-------------------
70+
71+
.. automodule:: api.tests.layer
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
:mod:`node` Module
77+
------------------
78+
79+
.. automodule:: api.tests.node
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
:mod:`provider` Module
85+
----------------------
86+
87+
.. automodule:: api.tests.provider
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
:mod:`release` Module
93+
---------------------
94+
95+
.. automodule:: api.tests.release
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:

‎docs/api/celerytasks.rst‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
celerytasks Package
2+
===================
3+
4+
:mod:`azuresms` Module
5+
----------------------
6+
7+
.. automodule:: celerytasks.azuresms
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
:mod:`chef` Module
13+
------------------
14+
15+
.. automodule:: celerytasks.chef
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
:mod:`chef_mock` Module
21+
-----------------------
22+
23+
.. automodule:: celerytasks.chef_mock
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
:mod:`chef_rsa` Module
29+
----------------------
30+
31+
.. automodule:: celerytasks.chef_rsa
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
:mod:`controller` Module
37+
------------------------
38+
39+
.. automodule:: celerytasks.controller
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
:mod:`ec2` Module
45+
-----------------
46+
47+
.. automodule:: celerytasks.ec2
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
:mod:`mock` Module
53+
------------------
54+
55+
.. automodule:: celerytasks.mock
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
:mod:`util` Module
61+
------------------
62+
63+
.. automodule:: celerytasks.util
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
Subpackages
69+
-----------
70+
71+
.. toctree::
72+
73+
celerytasks.tests

‎docs/api/celerytasks.tests.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
tests Package
2+
=============
3+
4+
:mod:`tests` Package
5+
--------------------
6+
7+
.. automodule:: celerytasks.tests
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
:mod:`azuretest` Module
13+
-----------------------
14+
15+
.. automodule:: celerytasks.tests.azuretest
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
:mod:`chef` Module
21+
------------------
22+
23+
.. automodule:: celerytasks.tests.chef
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

0 commit comments

Comments
 (0)