mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
0f4469c2b1
This should make previewing documentation easier. Also updated the Makefile to now copy the theme dir into the _build/website/ dir. Make connect and Make push work.
186 lines
6.4 KiB
Makefile
186 lines
6.4 KiB
Makefile
# Makefile for Sphinx documentation
|
|
#
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS =
|
|
SPHINXBUILD = sphinx-build
|
|
PAPER =
|
|
BUILDDIR = _build
|
|
|
|
# Internal variables.
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
|
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sources
|
|
# the i18n builder cannot share the environment and doctrees with the others
|
|
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
|
|
|
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
|
|
|
help:
|
|
@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 " texinfo to make Texinfo files"
|
|
# @echo " info to make Texinfo files and run them through makeinfo"
|
|
# @echo " gettext to make PO message catalogs"
|
|
# @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 " docs to build the docs and copy the static files to the outputdir"
|
|
@echo " publish to publish the app to dotcloud"
|
|
|
|
clean:
|
|
-rm -rf $(BUILDDIR)/*
|
|
|
|
docs:
|
|
-rm -rf $(BUILDDIR)/*
|
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
@echo
|
|
@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."
|
|
|
|
|
|
site:
|
|
cp -r website $(BUILDDIR)/
|
|
cp -r theme/docker/static/ $(BUILDDIR)/website/
|
|
@echo
|
|
@echo "The Website pages are in $(BUILDDIR)/site."
|
|
|
|
connect:
|
|
@echo connecting dotcloud to www.docker.io website, make sure to use user 1
|
|
@cd _build/website/ ; \
|
|
dotcloud list ; \
|
|
dotcloud connect dockerwebsite
|
|
|
|
push:
|
|
@cd _build/website/ ; \
|
|
dotcloud push
|
|
|
|
github-deploy: docs
|
|
rm -fr github-deploy
|
|
git clone ssh://git@github.com/dotcloud/docker github-deploy
|
|
cd github-deploy && git checkout -f gh-pages && git rm -r * && rsync -avH ../_build/html/ ./ && touch .nojekyll && echo "docker.io" > CNAME && git add * && git commit -m "Updating docs"
|
|
|
|
$(VERSIONS):
|
|
@echo "Hello world"
|
|
|
|
html:
|
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
|
|
|
dirhtml:
|
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
|
@echo
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
|
|
|
singlehtml:
|
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
|
@echo
|
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
|
|
|
pickle:
|
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
|
@echo
|
|
@echo "Build finished; now you can process the pickle files."
|
|
|
|
json:
|
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
|
@echo
|
|
@echo "Build finished; now you can process the JSON files."
|
|
|
|
htmlhelp:
|
|
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
|
@echo
|
|
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
|
".hhp project file in $(BUILDDIR)/htmlhelp."
|
|
|
|
qthelp:
|
|
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
|
@echo
|
|
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
|
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
|
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Docker.qhcp"
|
|
@echo "To view the help file:"
|
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Docker.qhc"
|
|
|
|
devhelp:
|
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
|
@echo
|
|
@echo "Build finished."
|
|
@echo "To view the help file:"
|
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/Docker"
|
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Docker"
|
|
@echo "# devhelp"
|
|
|
|
epub:
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
|
@echo
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
|
|
|
latex:
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
@echo
|
|
@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:
|
|
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
@echo "Running LaTeX files through pdflatex..."
|
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
|
|
text:
|
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
|
@echo
|
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
|
|
|
man:
|
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
|
@echo
|
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
|
|
|
texinfo:
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
@echo
|
|
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
|
@echo "Run \`make' in that directory to run these through makeinfo" \
|
|
"(use \`make info' here to do that automatically)."
|
|
|
|
info:
|
|
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
|
@echo "Running Texinfo files through makeinfo..."
|
|
make -C $(BUILDDIR)/texinfo info
|
|
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
|
|
|
gettext:
|
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
|
@echo
|
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
|
|
|
changes:
|
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
|
@echo
|
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
|
|
|
linkcheck:
|
|
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
|
@echo
|
|
@echo "Link check complete; look for any errors in the above output " \
|
|
"or in $(BUILDDIR)/linkcheck/output.txt."
|
|
|
|
doctest:
|
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
|
@echo "Testing of doctests in the sources finished, look at the " \
|
|
"results in $(BUILDDIR)/doctest/output.txt."
|