Skip to content

Commit b75a09b

Browse files
ByronByron
committed
Added docs framework
1 parent 03767cc commit b75a09b

6 files changed

Lines changed: 430 additions & 0 deletions

File tree

‎doc/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build
2+
*.version_info

‎doc/Makefile‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
15+
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
16+
17+
help:
18+
@echo "Please use \`make <target>' where <target> is one of"
19+
@echo " html to make standalone HTML files"
20+
@echo " dirhtml to make HTML files named index.html in directories"
21+
@echo " pickle to make pickle files"
22+
@echo " json to make JSON files"
23+
@echo " htmlhelp to make HTML files and a HTML help project"
24+
@echo " qthelp to make HTML files and a qthelp project"
25+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
26+
@echo " changes to make an overview of all changed/added/deprecated items"
27+
@echo " linkcheck to check all external links for integrity"
28+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
29+
30+
clean:
31+
-rm -rf $(BUILDDIR)/*
32+
33+
html:
34+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
35+
@echo
36+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
37+
38+
dirhtml:
39+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
40+
@echo
41+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
42+
43+
pickle:
44+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
45+
@echo
46+
@echo "Build finished; now you can process the pickle files."
47+
48+
json:
49+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
50+
@echo
51+
@echo "Build finished; now you can process the JSON files."
52+
53+
htmlhelp:
54+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
55+
@echo
56+
@echo "Build finished; now you can run HTML Help Workshop with the" \
57+
".hhp project file in $(BUILDDIR)/htmlhelp."
58+
59+
qthelp:
60+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
61+
@echo
62+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
63+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
64+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/smmap.qhcp"
65+
@echo "To view the help file:"
66+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/smmap.qhc"
67+
68+
latex:
69+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
70+
@echo
71+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
72+
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
73+
"run these through (pdf)latex."
74+
75+
changes:
76+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
77+
@echo
78+
@echo "The overview file is in $(BUILDDIR)/changes."
79+
80+
linkcheck:
81+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
82+
@echo
83+
@echo "Link check complete; look for any errors in the above output " \
84+
"or in $(BUILDDIR)/linkcheck/output.txt."
85+
86+
doctest:
87+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
88+
@echo "Testing of doctests in the sources finished, look at the " \
89+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/make.bat‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
@ECHO OFF
2+
3+
REM Command file for Sphinx documentation
4+
5+
set SPHINXBUILD=sphinx-build
6+
set BUILDDIR=build
7+
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
8+
if NOT "%PAPER%" == "" (
9+
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
10+
)
11+
12+
if "%1" == "" goto help
13+
14+
if "%1" == "help" (
15+
:help
16+
echo.Please use `make ^<target^>` where ^<target^> is one of
17+
echo. html to make standalone HTML files
18+
echo. dirhtml to make HTML files named index.html in directories
19+
echo. pickle to make pickle files
20+
echo. json to make JSON files
21+
echo. htmlhelp to make HTML files and a HTML help project
22+
echo. qthelp to make HTML files and a qthelp project
23+
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
24+
echo. changes to make an overview over all changed/added/deprecated items
25+
echo. linkcheck to check all external links for integrity
26+
echo. doctest to run all doctests embedded in the documentation if enabled
27+
goto end
28+
)
29+
30+
if "%1" == "clean" (
31+
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
32+
del /q /s %BUILDDIR%\*
33+
goto end
34+
)
35+
36+
if "%1" == "html" (
37+
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
38+
echo.
39+
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
40+
goto end
41+
)
42+
43+
if "%1" == "dirhtml" (
44+
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
45+
echo.
46+
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
47+
goto end
48+
)
49+
50+
if "%1" == "pickle" (
51+
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
52+
echo.
53+
echo.Build finished; now you can process the pickle files.
54+
goto end
55+
)
56+
57+
if "%1" == "json" (
58+
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
59+
echo.
60+
echo.Build finished; now you can process the JSON files.
61+
goto end
62+
)
63+
64+
if "%1" == "htmlhelp" (
65+
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
66+
echo.
67+
echo.Build finished; now you can run HTML Help Workshop with the ^
68+
.hhp project file in %BUILDDIR%/htmlhelp.
69+
goto end
70+
)
71+
72+
if "%1" == "qthelp" (
73+
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
74+
echo.
75+
echo.Build finished; now you can run "qcollectiongenerator" with the ^
76+
.qhcp project file in %BUILDDIR%/qthelp, like this:
77+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\smmap.qhcp
78+
echo.To view the help file:
79+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\smmap.ghc
80+
goto end
81+
)
82+
83+
if "%1" == "latex" (
84+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
85+
echo.
86+
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
87+
goto end
88+
)
89+
90+
if "%1" == "changes" (
91+
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
92+
echo.
93+
echo.The overview file is in %BUILDDIR%/changes.
94+
goto end
95+
)
96+
97+
if "%1" == "linkcheck" (
98+
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
99+
echo.
100+
echo.Link check complete; look for any errors in the above output ^
101+
or in %BUILDDIR%/linkcheck/output.txt.
102+
goto end
103+
)
104+
105+
if "%1" == "doctest" (
106+
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
107+
echo.
108+
echo.Testing of doctests in the sources finished, look at the ^
109+
results in %BUILDDIR%/doctest/output.txt.
110+
goto end
111+
)
112+
113+
:end

‎doc/source/changes.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#########
2+
Changelog
3+
#########
4+
5+
**********
6+
v0.8.0
7+
**********
8+
9+
- Initial Release

0 commit comments

Comments
 (0)