Skip to content
This repository was archived by the owner on Mar 15, 2019. It is now read-only.

Commit 89d1280

Browse files
andersy005andersy005
committed
Add sphinx docs boilerplate code
1 parent 820f646 commit 89d1280

File tree

7 files changed

+423
-0
lines changed

7 files changed

+423
-0
lines changed

‎docs/Makefile

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
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+
# User-friendly check for sphinx-build
10+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
11+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
12+
endif
13+
14+
# Internal variables.
15+
PAPEROPT_a4 = -D latex_paper_size=a4
16+
PAPEROPT_letter = -D latex_paper_size=letter
17+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
18+
# the i18n builder cannot share the environment and doctrees with the others
19+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
20+
21+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
22+
23+
help:
24+
@echo "Please use \`make <target>' where <target> is one of"
25+
@echo " html to make standalone HTML files"
26+
@echo " dirhtml to make HTML files named index.html in directories"
27+
@echo " singlehtml to make a single large HTML file"
28+
@echo " pickle to make pickle files"
29+
@echo " json to make JSON files"
30+
@echo " htmlhelp to make HTML files and a HTML help project"
31+
@echo " qthelp to make HTML files and a qthelp project"
32+
@echo " devhelp to make HTML files and a Devhelp project"
33+
@echo " epub to make an epub"
34+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
35+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
36+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
37+
@echo " text to make text files"
38+
@echo " man to make manual pages"
39+
@echo " texinfo to make Texinfo files"
40+
@echo " info to make Texinfo files and run them through makeinfo"
41+
@echo " gettext to make PO message catalogs"
42+
@echo " changes to make an overview of all changed/added/deprecated items"
43+
@echo " xml to make Docutils-native XML files"
44+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
45+
@echo " linkcheck to check all external links for integrity"
46+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
47+
48+
clean:
49+
rm -rf $(BUILDDIR)/*
50+
51+
html:
52+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
53+
@echo
54+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
55+
56+
dirhtml:
57+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
58+
@echo
59+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
60+
61+
singlehtml:
62+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
63+
@echo
64+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
65+
66+
pickle:
67+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
68+
@echo
69+
@echo "Build finished; now you can process the pickle files."
70+
71+
json:
72+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
73+
@echo
74+
@echo "Build finished; now you can process the JSON files."
75+
76+
htmlhelp:
77+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
78+
@echo
79+
@echo "Build finished; now you can run HTML Help Workshop with the" \
80+
".hhp project file in $(BUILDDIR)/htmlhelp."
81+
82+
qthelp:
83+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
84+
@echo
85+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
86+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
87+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/xshape.qhcp"
88+
@echo "To view the help file:"
89+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/xshape.qhc"
90+
91+
devhelp:
92+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
93+
@echo
94+
@echo "Build finished."
95+
@echo "To view the help file:"
96+
@echo "# mkdir -p $$HOME/.local/share/devhelp/xshape"
97+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/xshape"
98+
@echo "# devhelp"
99+
100+
epub:
101+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
102+
@echo
103+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
104+
105+
latex:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo
108+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
109+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
110+
"(use \`make latexpdf' here to do that automatically)."
111+
112+
latexpdf:
113+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
114+
@echo "Running LaTeX files through pdflatex..."
115+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
116+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
117+
118+
latexpdfja:
119+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
120+
@echo "Running LaTeX files through platex and dvipdfmx..."
121+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
122+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
123+
124+
text:
125+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
126+
@echo
127+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
128+
129+
man:
130+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
131+
@echo
132+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
133+
134+
texinfo:
135+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
136+
@echo
137+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
138+
@echo "Run \`make' in that directory to run these through makeinfo" \
139+
"(use \`make info' here to do that automatically)."
140+
141+
info:
142+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143+
@echo "Running Texinfo files through makeinfo..."
144+
make -C $(BUILDDIR)/texinfo info
145+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
146+
147+
gettext:
148+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
149+
@echo
150+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
151+
152+
changes:
153+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
154+
@echo
155+
@echo "The overview file is in $(BUILDDIR)/changes."
156+
157+
linkcheck:
158+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
159+
@echo
160+
@echo "Link check complete; look for any errors in the above output " \
161+
"or in $(BUILDDIR)/linkcheck/output.txt."
162+
163+
doctest:
164+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
165+
@echo "Testing of doctests in the sources finished, look at the " \
166+
"results in $(BUILDDIR)/doctest/output.txt."
167+
168+
xml:
169+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
170+
@echo
171+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
172+
173+
pseudoxml:
174+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
175+
@echo
176+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎docs/make.bat

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=python -msphinx
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=_build
12+
set SPHINXPROJ=intake_cmip5
13+
14+
if "%1" == "" goto help
15+
16+
%SPHINXBUILD% >NUL 2>NUL
17+
if errorlevel 9009 (
18+
echo.
19+
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
20+
echo.then set the SPHINXBUILD environment variable to point to the full
21+
echo.path of the 'sphinx-build' executable. Alternatively you may add the
22+
echo.Sphinx directory to PATH.
23+
echo.
24+
echo.If you don't have Sphinx installed, grab it from
25+
echo.http://sphinx-doc.org/
26+
exit /b 1
27+
)
28+
29+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30+
goto end
31+
32+
:help
33+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34+
35+
:end
36+
popd

‎docs/source/api.rst

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
API
2+
===

0 commit comments

Comments
 (0)