Changeset 4213 for trunk/docs/Makefile


Ignore:
Timestamp:
Dec 19, 2019 11:04:03 PM (3 years ago)
Author:
toby
Message:

multiple small changes to allow docs build under 3.x

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/Makefile

    r2027 r4213  
    1 # Makefile for Sphinx documentation
     1# Minimal makefile for Sphinx documentation
    22#
    33
    4 # You can set these variables from the command line.
    5 SPHINXOPTS    =
    6 SPHINXBUILD   = sphinx-build
    7 PAPER         =
     4# You can set these variables from the command line, and also
     5# from the environment for the first two.
     6SPHINXOPTS    ?=
     7SPHINXBUILD   ?= sphinx-build
     8SOURCEDIR     = source
    89BUILDDIR      = build
    910
    10 # Internal variables.
    11 PAPEROPT_a4     = -D latex_paper_size=a4
    12 PAPEROPT_letter = -D latex_paper_size=letter
    13 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
    14 # the i18n builder cannot share the environment and doctrees with the others
    15 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
     11# Put it first so that "make" without argument is like "make help".
     12help:
     13        @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
    1614
    17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
     15.PHONY: help Makefile
    1816
    19 help:
    20         @echo "Please use \`make <target>' where <target> is one of"
    21         @echo "  html       to make standalone HTML files"
    22         @echo "  dirhtml    to make HTML files named index.html in directories"
    23         @echo "  singlehtml to make a single large HTML file"
    24         @echo "  pickle     to make pickle files"
    25         @echo "  json       to make JSON files"
    26         @echo "  htmlhelp   to make HTML files and a HTML help project"
    27         @echo "  qthelp     to make HTML files and a qthelp project"
    28         @echo "  devhelp    to make HTML files and a Devhelp project"
    29         @echo "  epub       to make an epub"
    30         @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
    31         @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
    32         @echo "  text       to make text files"
    33         @echo "  man        to make manual pages"
    34         @echo "  texinfo    to make Texinfo files"
    35         @echo "  info       to make Texinfo files and run them through makeinfo"
    36         @echo "  gettext    to make PO message catalogs"
    37         @echo "  changes    to make an overview of all changed/added/deprecated items"
    38         @echo "  linkcheck  to check all external links for integrity"
    39         @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
    40 
    41 clean:
    42         #-rm -rf $(BUILDDIR)/*
    43         rm $(BUILDDIR)/doctrees/* $(BUILDDIR)/html/*.html $(BUILDDIR)/html/*.js $(BUILDDIR)/html/*/*.html
    44 
    45 html:
    46         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
    47         @echo
    48         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
    49 
    50 dirhtml:
    51         $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
    52         @echo
    53         @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
    54 
    55 singlehtml:
    56         $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
    57         @echo
    58         @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
    59 
    60 pickle:
    61         $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
    62         @echo
    63         @echo "Build finished; now you can process the pickle files."
    64 
    65 json:
    66         $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
    67         @echo
    68         @echo "Build finished; now you can process the JSON files."
    69 
    70 htmlhelp:
    71         $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
    72         @echo
    73         @echo "Build finished; now you can run HTML Help Workshop with the" \
    74               ".hhp project file in $(BUILDDIR)/htmlhelp."
    75 
    76 qthelp:
    77         $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
    78         @echo
    79         @echo "Build finished; now you can run "qcollectiongenerator" with the" \
    80               ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
    81         @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EPICSPythonSPECmotor.qhcp"
    82         @echo "To view the help file:"
    83         @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EPICSPythonSPECmotor.qhc"
    84 
    85 devhelp:
    86         $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
    87         @echo
    88         @echo "Build finished."
    89         @echo "To view the help file:"
    90         @echo "# mkdir -p $$HOME/.local/share/devhelp/EPICSPythonSPECmotor"
    91         @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EPICSPythonSPECmotor"
    92         @echo "# devhelp"
    93 
    94 epub:
    95         $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
    96         @echo
    97         @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
    98 
    99 latex:
    100         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
    101         @echo
    102         @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
    103         @echo "Run \`make' in that directory to run these through (pdf)latex" \
    104               "(use \`make latexpdf' here to do that automatically)."
    105 
    106 latexpdf:
    107         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
    108         @echo "Running LaTeX files through pdflatex..."
    109         $(MAKE) -C $(BUILDDIR)/latex all-pdf
    110         @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
    111 
    112 text:
    113         $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
    114         @echo
    115         @echo "Build finished. The text files are in $(BUILDDIR)/text."
    116 
    117 man:
    118         $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
    119         @echo
    120         @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
    121 
    122 texinfo:
    123         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
    124         @echo
    125         @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
    126         @echo "Run \`make' in that directory to run these through makeinfo" \
    127               "(use \`make info' here to do that automatically)."
    128 
    129 info:
    130         $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
    131         @echo "Running Texinfo files through makeinfo..."
    132         make -C $(BUILDDIR)/texinfo info
    133         @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
    134 
    135 gettext:
    136         $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
    137         @echo
    138         @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
    139 
    140 changes:
    141         $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
    142         @echo
    143         @echo "The overview file is in $(BUILDDIR)/changes."
    144 
    145 linkcheck:
    146         $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
    147         @echo
    148         @echo "Link check complete; look for any errors in the above output " \
    149               "or in $(BUILDDIR)/linkcheck/output.txt."
    150 
    151 doctest:
    152         $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
    153         @echo "Testing of doctests in the sources finished, look at the " \
    154               "results in $(BUILDDIR)/doctest/output.txt."
     17# Catch-all target: route all unknown targets to Sphinx using the new
     18# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
     19%: Makefile
     20        @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Note: See TracChangeset for help on using the changeset viewer.