Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
186 lines (157 sloc) 6.58 KB
# Makefile for Sphinx documentation
# You can set these variables from the command line.
SPHINXBUILD = sphinx-build
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " gh-pages to publish htmls on gh-pages branch for GitHub"
-rm -rf $(BUILDDIR)/*
html: pre-build
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml: pre-build
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml: pre-build
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle: pre-build
@echo "Build finished; now you can process the pickle files."
json: pre-build
@echo "Build finished; now you can process the JSON files."
htmlhelp: pre-build
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp: pre-build
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GotGitHub.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GotGitHub.qhc"
devhelp: pre-build
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/GotGitHub"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GotGitHub"
@echo "# devhelp"
epub: pre-build
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex: pre-build
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf: pre-build
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text: pre-build
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man: pre-build
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes: pre-build
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck: pre-build
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
gh-pages: clean html
@if ! git rev-parse refs/heads/gh-pages >/dev/null 2>&1 ; then \
echo "Branch gh-pages not exists, forgot check it out?" >&2; \
exit 1; \
@cp _build/html/
@echo '*' > _build/html/images/.gitignore
@git add -f _build/html; \
tree=$$(git write-tree); \
newhtml=$$(git ls-tree $$tree:_build | grep "html$$" | awk '{print $$3;}') ; \
oldhtml=$$(git rev-parse refs/heads/gh-pages^{tree}); \
if [ "$$oldhtml" = "$$newhtml" ]; then \
echo "HTML is uptodate, branch gh-pages not changed." ; \
else \
commit=$$(git log --format=%B -1 | git commit-tree $$newhtml -p refs/heads/gh-pages) ; \
git update-ref -m "HTML compiled from $$(git rev-parse HEAD)" refs/heads/gh-pages $$commit ; \
echo "Branch gh-pages changed." ; \
[ -x .git/hooks/post-commit ] && .git/hooks/post-commit; \
fi; \
git rm --cached -r -q _build/html
@if ! git rev-parse refs/heads/gh-pages^ >/dev/null 2>&1 ; then \
echo "Branch gh-pages not exists or only one commit, forgot check it out?" >&2; \
exit 1; \
if git update-ref -m "shift from $$(git rev-parse refs/heads/gh-pages)" refs/heads/gh-pages $$(git rev-parse refs/heads/gh-pages^); then \
echo "gh-pages branch shift to last commit."; \
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
pre-build: images update-version
@(cd graphics; \
if test -f Rakefile; then \
rake convert[../images,600]; \
else \
echo "ERROR: Submodule 'graphics' not found. Please init submodule using: " >&2; \
echo "ERROR: git submodule init && git submodule update" >&2; \
exit 1; \
@sed -e "s#<version>#$$(git describe --dirty --always)#g" < >
@if diff -q >/dev/null 2>&1; then \
rm; \
else \
echo " =>" ; \
mv; \
.PHONY : clean pre-build images gh-pages
Something went wrong with that request. Please try again.