183 lines
6.6 KiB
Makefile
183 lines
6.6 KiB
Makefile
|
# docs/Makefile.am for anaconda
|
||
|
|
#
|
||
|
|
# Copyright (C) 2009 Red Hat, Inc.
|
||
|
|
#
|
||
|
|
# This program is free software; you can redistribute it and/or modify
|
||
|
|
# it under the terms of the GNU Lesser General Public License as published
|
||
|
|
# by the Free Software Foundation; either version 2.1 of the License, or
|
||
|
|
# (at your option) any later version.
|
||
|
|
#
|
||
|
|
# This program is distributed in the hope that it will be useful,
|
||
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
# GNU Lesser General Public License for more details.
|
||
|
|
#
|
||
|
|
# You should have received a copy of the GNU Lesser General Public License
|
||
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
EXTRA_DIST = $(srcdir)/*.rst $(srcdir)/conf.py
|
||
|
|
|
||
|
|
CLEANFILES = api $(builddir)/*.xml
|
||
|
|
|
||
|
|
MAINTAINERCLEANFILES = Makefile.in
|
||
|
|
|
||
|
|
|
||
|
|
#
|
||
|
|
# Makefile for Sphinx documentation
|
||
|
|
#
|
||
|
|
|
||
|
|
# You can set these variables from the command line.
|
||
|
|
SPHINXOPTS =
|
||
|
|
SPHINXBUILD = sphinx-build-3
|
||
|
|
SPHINXAPIDOC = sphinx-apidoc-3
|
||
|
|
PAPER =
|
||
|
|
BUILDDIR = .
|
||
|
|
SOURCEDIR = ../pyanaconda
|
||
|
|
MODULE_NAMES = modules.rst pyanaconda.*rst
|
||
|
|
|
||
|
|
# Internal variables.
|
||
|
|
PAPEROPT_a4 = -D latex_paper_size=a4
|
||
|
|
PAPEROPT_letter = -D latex_paper_size=letter
|
||
|
|
ALLSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||
|
|
# 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 apidoc
|
||
|
|
|
||
|
|
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)"
|
||
|
|
|
||
|
|
# rebuild the api *rst files if SPHINXAPIDOC is available.
|
||
|
|
apidoc:
|
||
|
|
if [ -f /usr/bin/$(SPHINXAPIDOC) ]; then \
|
||
|
|
rm $(addprefix ./, $(MODULE_NAMES)) ; \
|
||
|
|
$(SPHINXAPIDOC) -o . $(SOURCEDIR) ; \
|
||
|
|
rm $(addprefix ./, tests/*.rst) ; \
|
||
|
|
$(SPHINXAPIDOC) -o ./tests ../tests ../tests/storage/run_storage_tests.py ; \
|
||
|
|
fi
|
||
|
|
|
||
|
|
html: apidoc
|
||
|
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||
|
|
|
||
|
|
dirhtml: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||
|
|
@echo
|
||
|
|
@echo "Build finished; now you can process the pickle files."
|
||
|
|
|
||
|
|
json: apidoc
|
||
|
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||
|
|
@echo
|
||
|
|
@echo "Build finished; now you can process the JSON files."
|
||
|
|
|
||
|
|
htmlhelp: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(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/Anaconda.qhcp"
|
||
|
|
@echo "To view the help file:"
|
||
|
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Anaconda.qhc"
|
||
|
|
|
||
|
|
devhelp: apidoc
|
||
|
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||
|
|
@echo
|
||
|
|
@echo "Build finished."
|
||
|
|
@echo "To view the help file:"
|
||
|
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/Anaconda"
|
||
|
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Anaconda"
|
||
|
|
@echo "# devhelp"
|
||
|
|
|
||
|
|
epub: apidoc
|
||
|
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||
|
|
|
||
|
|
latex: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||
|
|
|
||
|
|
man: apidoc
|
||
|
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||
|
|
|
||
|
|
texinfo: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(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: apidoc
|
||
|
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||
|
|
@echo
|
||
|
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||
|
|
|
||
|
|
changes: apidoc
|
||
|
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||
|
|
@echo
|
||
|
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||
|
|
|
||
|
|
linkcheck: apidoc
|
||
|
|
$(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."
|