Skip to content
This repository was archived by the owner on Dec 3, 2024. It is now read-only.

Commit 0d81ad9

Browse files
lkiesowlkiesow
committed
Introduced Sphinx based Documentation
To auto-generate the documentation for the ess-player project switch into the doc directory and run: make clean html Signed-off-by: Lars Kiesow <[email protected]>
1 parent c8e3f4a commit 0d81ad9

21 files changed

+1465
-31
lines changed

‎doc/Makefile

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
#SPHINXBUILD = python /home/lars/master-thesis/code/modules/core/venv/bin/sphinx-build
8+
PAPER =
9+
BUILDDIR = _build
10+
11+
# Internal variables.
12+
PAPEROPT_a4 = -D latex_paper_size=a4
13+
PAPEROPT_letter = -D latex_paper_size=letter
14+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
15+
# the i18n builder cannot share the environment and doctrees with the others
16+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
17+
18+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
19+
20+
help:
21+
@echo "Please use \`make <target>' where <target> is one of"
22+
@echo " html to make standalone HTML files"
23+
@echo " dirhtml to make HTML files named index.html in directories"
24+
@echo " singlehtml to make a single large HTML file"
25+
@echo " pickle to make pickle files"
26+
@echo " json to make JSON files"
27+
@echo " htmlhelp to make HTML files and a HTML help project"
28+
@echo " qthelp to make HTML files and a qthelp project"
29+
@echo " devhelp to make HTML files and a Devhelp project"
30+
@echo " epub to make an epub"
31+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
32+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
33+
@echo " text to make text files"
34+
@echo " man to make manual pages"
35+
@echo " texinfo to make Texinfo files"
36+
@echo " info to make Texinfo files and run them through makeinfo"
37+
@echo " gettext to make PO message catalogs"
38+
@echo " changes to make an overview of all changed/added/deprecated items"
39+
@echo " linkcheck to check all external links for integrity"
40+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
41+
42+
clean:
43+
-rm -rf $(BUILDDIR)/*
44+
45+
html:
46+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
47+
@echo
48+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
49+
50+
dirhtml:
51+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
52+
@echo
53+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
54+
55+
singlehtml:
56+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
57+
@echo
58+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
59+
60+
pickle:
61+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
62+
@echo
63+
@echo "Build finished; now you can process the pickle files."
64+
65+
json:
66+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
67+
@echo
68+
@echo "Build finished; now you can process the JSON files."
69+
70+
htmlhelp:
71+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
72+
@echo
73+
@echo "Build finished; now you can run HTML Help Workshop with the" \
74+
".hhp project file in $(BUILDDIR)/htmlhelp."
75+
76+
qthelp:
77+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
78+
@echo
79+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
80+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
81+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Lernfunk3.qhcp"
82+
@echo "To view the help file:"
83+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Lernfunk3.qhc"
84+
85+
devhelp:
86+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
87+
@echo
88+
@echo "Build finished."
89+
@echo "To view the help file:"
90+
@echo "# mkdir -p $$HOME/.local/share/devhelp/Lernfunk3"
91+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Lernfunk3"
92+
@echo "# devhelp"
93+
94+
epub:
95+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
96+
@echo
97+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
98+
99+
latex:
100+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
101+
@echo
102+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
103+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
104+
"(use \`make latexpdf' here to do that automatically)."
105+
106+
latexpdf:
107+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108+
@echo "Running LaTeX files through pdflatex..."
109+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
110+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
111+
112+
text:
113+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
114+
@echo
115+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
116+
117+
man:
118+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
119+
@echo
120+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
121+
122+
texinfo:
123+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
124+
@echo
125+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
126+
@echo "Run \`make' in that directory to run these through makeinfo" \
127+
"(use \`make info' here to do that automatically)."
128+
129+
info:
130+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
131+
@echo "Running Texinfo files through makeinfo..."
132+
make -C $(BUILDDIR)/texinfo info
133+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
134+
135+
gettext:
136+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
137+
@echo
138+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
139+
140+
changes:
141+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
142+
@echo
143+
@echo "The overview file is in $(BUILDDIR)/changes."
144+
145+
linkcheck:
146+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
147+
@echo
148+
@echo "Link check complete; look for any errors in the above output " \
149+
"or in $(BUILDDIR)/linkcheck/output.txt."
150+
151+
doctest:
152+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
153+
@echo "Testing of doctests in the sources finished, look at the " \
154+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/_static/lernfunk.css

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
@import url("haiku.css");
2+
3+
dl.function > dt, dl.method > dt,dl.attribute > dt, dl.class > dt, dl.get > dt, dl.post > dt, dl.put > dt, dl.delete > dt, dl.data > dt, div.apititle {
4+
padding: 5px;
5+
padding-left: 15px;
6+
border-radius: 3px;
7+
border-top: 1px solid gray;
8+
background-color: silver;
9+
}
10+
11+
dl.class {
12+
border-left: 5px solid silver;
13+
padding-bottom: 10px;
14+
margin-bottom: 30px;
15+
}
16+
17+
table.docutils td, table.docutils th, table.docutils tr {
18+
border: none;
19+
}
20+
21+
table.docutils thead tr {
22+
border-bottom: 1px solid gray;
23+
}
24+
25+
table.docutils {
26+
border-top: 2px solid gray;
27+
border-bottom: 2px solid gray;
28+
}
29+
30+
div.apitoc {
31+
border-bottom: 2px solid silver;
32+
border-left: 10px solid silver;
33+
}
34+
35+
div.apitoc a {
36+
display: block;
37+
padding: 0px;
38+
padding-left: 10px;
39+
color: black;
40+
}
41+
42+
div.apitoc a:hover {
43+
background-color: #eee;
44+
}
45+
46+
div.apitoc a.second {
47+
padding-left: 25px;
48+
}
49+
50+
div.apitoc a.partOfClass {
51+
padding-left: 25px;
52+
border-left: 3px solid silver;
53+
margin-left: 25px;
54+
}
55+
56+
div.apitoc span.apilnclassname, div.apitoc big, div.apitoc em {
57+
font-weight: lighter;
58+
}
59+
60+
div.apitoc big, div.apitoc em {
61+
color: #666;
62+
}
63+
64+
div.apitoc span.apilnname {
65+
font-weight: bold;
66+
}
67+
68+
69+
a.headerlink {
70+
color: gray;
71+
}
72+
73+
/*
74+
li.toctree-l3 {
75+
display: inline-block;
76+
min-width: 200px;
77+
padding: 0px;
78+
margin: 0px;
79+
}
80+
81+
li.toctree-l3 a {
82+
display: block;
83+
margin: 1px 10px;
84+
padding: 3px 10px;
85+
border-radius: 3px;
86+
}
87+
88+
li.toctree-l3 a:hover {
89+
background-color: #eee;
90+
}
91+
*/

‎doc/_static/logo.png

5.54 KB
Loading

‎doc/_static/theme_extras.js

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
$(document).ready(function() {
2+
$('.headerlink').each(function( index ) {
3+
var type = $(this).parent().get(0).nodeName
4+
if (type == 'H1') {
5+
var name = $(this).parent().get(0).childNodes[0].data;
6+
var ln = $(this).attr('href');
7+
$('div.apitoc').append('<a href="'+ln+'">'+name+'</a>');
8+
} else if (type == 'H2') {
9+
var name = $(this).parent().get(0).childNodes[0].data;
10+
var ln = $(this).attr('href');
11+
$('div.apitoc').append('<a class="h2" href="'+ln+'">'+name+'</a>');
12+
} else if (type == 'DT') {
13+
//var name = $(this).parent().text().replace('¶', '');
14+
var name = $(this).parent().html().replace(/<a .*<\/a>/g, '')
15+
.replace(/<tt class="desc/g, '<span class="apiln')
16+
.replace(/<\/tt>/g, '</span>');
17+
var ln = $(this).attr('href');
18+
var p = $(this).parent().parent();
19+
if ( p.hasClass('method') || p.hasClass('attribute') ) {
20+
$('div.apitoc').append('<a class="partOfClass" href="'+ln+'">'+name+'</a>');
21+
} else {
22+
$('div.apitoc').append('<a class="second" href="'+ln+'">'+name+'</a>');
23+
}
24+
} else {
25+
alert( type );
26+
}
27+
});
28+
});

‎doc/api.db.rst

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. raw:: html
2+
3+
<div class="apititle"><b>Contents</b></div>
4+
<div class="apitoc"></div>
5+
6+
.. automodule:: ess.db
7+
:members:

‎doc/api.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
API Documentation
2+
=================
3+
4+
.. toctree::
5+
:maxdepth: 3
6+
7+
api.db
8+
api.server

‎doc/api.server.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.. automodule:: ess.server
2+
:members:

0 commit comments

Comments
 (0)