Return to Makefile.am CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / gpl / axl / py-axl / doc

Annotation of gpl/axl/py-axl/doc/Makefile.am, revision 1.1.1.1

1.1       misho       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: 
                      9: EXTRA_DIST = py-axl-doc.css conf.py conf.py.in make.bat \
                     10:        license.rst index.rst \
                     11:        axl.rst \
                     12:        doc.rst \
                     13:        error.rst \
                     14:        node.rst \
                     15:        dtd.rst \
                     16:        attr_cursor.rst
                     17: 
                     18: # Internal variables.
                     19: PAPEROPT_a4     = -D latex_paper_size=a4
                     20: PAPEROPT_letter = -D latex_paper_size=letter
                     21: ALLSPHINXOPTS   = -d _build/doctrees $(SPHINXOPTS) .
                     22: 
                     23: .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
                     24: 
                     25: all:
                     26: 
                     27: help:
                     28:        @echo "Please use \`make <target>' where <target> is one of"
                     29:        @echo "  html      to make standalone HTML files"
                     30:        @echo "  dirhtml   to make HTML files named index.html in directories"
                     31:        @echo "  pickle    to make pickle files"
                     32:        @echo "  json      to make JSON files"
                     33:        @echo "  htmlhelp  to make HTML files and a HTML help project"
                     34:        @echo "  qthelp    to make HTML files and a qthelp project"
                     35:        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
                     36:        @echo "  changes   to make an overview of all changed/added/deprecated items"
                     37:        @echo "  linkcheck to check all external links for integrity"
                     38:        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
                     39: 
                     40: clean:
                     41:        -rm -rf _build/*
                     42: 
                     43: build_doc: html
                     44: html:
                     45:        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
                     46:        cp py-axl-doc.css _build/html/_static/
                     47:        cp ../../doc/aspl-logo.png _build/html/
                     48:        cp ../../doc/main-page-logo.png _build/html/
                     49:        @echo
                     50:        @echo "Build finished. The HTML pages are in _build/html."
                     51: 
                     52: dirhtml:
                     53:        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
                     54:        @echo
                     55:        @echo "Build finished. The HTML pages are in _build/dirhtml."
                     56: 
                     57: pickle:
                     58:        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
                     59:        @echo
                     60:        @echo "Build finished; now you can process the pickle files."
                     61: 
                     62: json:
                     63:        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
                     64:        @echo
                     65:        @echo "Build finished; now you can process the JSON files."
                     66: 
                     67: htmlhelp:
                     68:        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
                     69:        @echo
                     70:        @echo "Build finished; now you can run HTML Help Workshop with the" \
                     71:              ".hhp project file in _build/htmlhelp."
                     72: 
                     73: qthelp:
                     74:        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
                     75:        @echo
                     76:        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
                     77:              ".qhcp project file in _build/qthelp, like this:"
                     78:        @echo "# qcollectiongenerator _build/qthelp/PyAxl.qhcp"
                     79:        @echo "To view the help file:"
                     80:        @echo "# assistant -collectionFile _build/qthelp/PyAxl.qhc"
                     81: 
                     82: latex:
                     83:        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
                     84:        @echo
                     85:        @echo "Build finished; the LaTeX files are in _build/latex."
                     86:        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
                     87:              "run these through (pdf)latex."
                     88: 
                     89: changes:
                     90:        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
                     91:        @echo
                     92:        @echo "The overview file is in _build/changes."
                     93: 
                     94: linkcheck:
                     95:        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
                     96:        @echo
                     97:        @echo "Link check complete; look for any errors in the above output " \
                     98:              "or in _build/linkcheck/output.txt."
                     99: 
                    100: doctest:
                    101:        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
                    102:        @echo "Testing of doctests in the sources finished, look at the " \
                    103:              "results in _build/doctest/output.txt."