Skip to content

Commit 60814b9

Browse files
mboersmamboersma
committed
Updated doc API layout.
1 parent aa2b715 commit 60814b9

5 files changed

Lines changed: 157 additions & 7 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ deis/local_settings.py
4242
venv/
4343
.vagrant
4444
.ruby-version
45+
.DS_Store
4546

‎docs/Makefile‎

Lines changed: 142 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
PAPER =
8+
PYTHON = python
89
BUILDDIR = build
910

1011
# User-friendly check for sphinx-build
@@ -19,7 +20,32 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
1920
# the i18n builder cannot share the environment and doctrees with the others
2021
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
2122

22-
.PHONY: clean docs publish
23+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
24+
25+
help:
26+
@echo "Please use \`make <target>' where <target> is one of"
27+
# @echo " html to make standalone HTML files"
28+
# @echo " dirhtml to make HTML files named index.html in directories"
29+
# @echo " singlehtml to make a single large HTML file"
30+
# @echo " pickle to make pickle files"
31+
# @echo " json to make JSON files"
32+
# @echo " htmlhelp to make HTML files and a HTML help project"
33+
# @echo " qthelp to make HTML files and a qthelp project"
34+
# @echo " devhelp to make HTML files and a Devhelp project"
35+
# @echo " epub to make an epub"
36+
# @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37+
# @echo " latexpdf to make LaTeX files and run them through pdflatex"
38+
# @echo " text to make text files"
39+
# @echo " man to make manual pages"
40+
# @echo " texinfo to make Texinfo files"
41+
# @echo " info to make Texinfo files and run them through makeinfo"
42+
# @echo " gettext to make PO message catalogs"
43+
# @echo " changes to make an overview of all changed/added/deprecated items"
44+
# @echo " linkcheck to check all external links for integrity"
45+
# @echo " doctest to run all doctests embedded in the documentation (if enabled)"
46+
@echo " docs to build the docs and copy the static files to the outputdir"
47+
@echo " server to serve the docs in your browser under \`http://localhost:8000\`"
48+
@echo " publish to publish the app to dotcloud"
2349

2450
docs:
2551
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -29,5 +55,119 @@ docs:
2955
publish:
3056
@echo "Coming soon..."
3157

58+
server: docs
59+
@cd $(BUILDDIR)/html; $(PYTHON) -m SimpleHTTPServer 8000
60+
3261
clean:
33-
rm -rf $(BUILDDIR)/*
62+
rm -rf $(BUILDDIR)
63+
64+
html:
65+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
66+
@echo
67+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
68+
69+
dirhtml:
70+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
71+
@echo
72+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
73+
74+
singlehtml:
75+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
76+
@echo
77+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
78+
79+
pickle:
80+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
81+
@echo
82+
@echo "Build finished; now you can process the pickle files."
83+
84+
json:
85+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
86+
@echo
87+
@echo "Build finished; now you can process the JSON files."
88+
89+
htmlhelp:
90+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
91+
@echo
92+
@echo "Build finished; now you can run HTML Help Workshop with the" \
93+
".hhp project file in $(BUILDDIR)/htmlhelp."
94+
95+
qthelp:
96+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
97+
@echo
98+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
99+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
100+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Docker.qhcp"
101+
@echo "To view the help file:"
102+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Docker.qhc"
103+
104+
devhelp:
105+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
106+
@echo
107+
@echo "Build finished."
108+
@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"
111+
@echo "# devhelp"
112+
113+
epub:
114+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
115+
@echo
116+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
117+
118+
latex:
119+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120+
@echo
121+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
122+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
123+
"(use \`make latexpdf' here to do that automatically)."
124+
125+
latexpdf:
126+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127+
@echo "Running LaTeX files through pdflatex..."
128+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
129+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
130+
131+
text:
132+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
133+
@echo
134+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
135+
136+
man:
137+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
138+
@echo
139+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
140+
141+
texinfo:
142+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143+
@echo
144+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
145+
@echo "Run \`make' in that directory to run these through makeinfo" \
146+
"(use \`make info' here to do that automatically)."
147+
148+
info:
149+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
150+
@echo "Running Texinfo files through makeinfo..."
151+
make -C $(BUILDDIR)/texinfo info
152+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
153+
154+
gettext:
155+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
156+
@echo
157+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
158+
159+
changes:
160+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
161+
@echo
162+
@echo "The overview file is in $(BUILDDIR)/changes."
163+
164+
linkcheck:
165+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
166+
@echo
167+
@echo "Link check complete; look for any errors in the above output " \
168+
"or in $(BUILDDIR)/linkcheck/output.txt."
169+
170+
doctest:
171+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
172+
@echo "Testing of doctests in the sources finished, look at the " \
173+
"results in $(BUILDDIR)/doctest/output.txt."

docs/source/api.rst renamed to docs/source/api/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
API
66
===
77

8+
.. automodule:: api
9+
:members:
10+
:undoc-members:
11+
12+
.. automodule:: celerytasks
13+
:members:
14+
:undoc-members:
15+
816
.. automodule:: api.fields
917
:members:
1018
:undoc-members:

‎docs/source/conf.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@
110110
# documentation.
111111
html_theme_options = {
112112
'collapsiblesidebar': True,
113-
'footerbgcolor': '#000',
114-
'sidebarbgcolor': '#000',
115-
'relbarbgcolor': '#000',
113+
# 'footerbgcolor': '#000',
114+
# 'sidebarbgcolor': '#000',
115+
# 'relbarbgcolor': '#000',
116116
# 'sidebarwidth': 280,
117117
}
118118

@@ -128,7 +128,7 @@
128128

129129
# The name of an image file (relative to this directory) to place at the top
130130
# of the sidebar.
131-
html_logo = 'opdemand_logo.png'
131+
# html_logo = 'opdemand_logo.png'
132132

133133
# The name of an image file (within the static path) to use as favicon of the
134134
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

‎requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
azure>=0.7.0
12
boto>=2.9.8
23
Django>=1.5.1
34
django-allauth>=0.12.0
45
django-celery>=3.0.17
56
django-json-field>=0.5.4
67
django-yamlfield>=0.4
78
djangorestframework>=2.3.6
8-
docutils>=0.10
9+
docutils>=0.11
910
gevent==0.13.8
1011
gunicorn>=0.17.5
1112
PIL>=1.1.7

0 commit comments

Comments
 (0)