Changeset 1662:427f1876f3e6 in orange-bioinformatics for docs/widgets/Makefile


Ignore:
Timestamp:
05/21/12 15:39:56 (2 years ago)
Author:
mitar
Branch:
default
Message:

Revamped documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • docs/widgets/Makefile

    r1623 r1662  
    66SPHINXBUILD   = sphinx-build 
    77PAPER         = 
     8BUILDDIR      = build 
    89 
    910# Internal variables. 
    1011PAPEROPT_a4     = -D latex_paper_size=a4 
    1112PAPEROPT_letter = -D latex_paper_size=letter 
    12 #ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 
    13 ALLSPHINXOPTS   = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) rst 
     13ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) rst 
    1414 
    15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest 
     15.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 
    1616 
    1717help: 
    1818    @echo "Please use \`make <target>' where <target> is one of" 
    19     @echo "  html      to make standalone HTML files" 
    20     @echo "  dirhtml   to make HTML files named index.html in directories" 
    21     @echo "  pickle    to make pickle files" 
    22     @echo "  json      to make JSON files" 
    23     @echo "  htmlhelp  to make HTML files and a HTML help project" 
    24     @echo "  qthelp    to make HTML files and a qthelp project" 
    25     @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 
    26     @echo "  changes   to make an overview of all changed/added/deprecated items" 
    27     @echo "  linkcheck to check all external links for integrity" 
    28     @echo "  doctest   to run all doctests embedded in the documentation (if enabled)" 
     19    @echo "  html       to make standalone HTML files" 
     20    @echo "  dirhtml    to make HTML files named index.html in directories" 
     21    @echo "  singlehtml to make a single large HTML file" 
     22    @echo "  pickle     to make pickle files" 
     23    @echo "  json       to make JSON files" 
     24    @echo "  htmlhelp   to make HTML files and a HTML help project" 
     25    @echo "  qthelp     to make HTML files and a qthelp project" 
     26    @echo "  devhelp    to make HTML files and a Devhelp project" 
     27    @echo "  epub       to make an epub" 
     28    @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 
     29    @echo "  latexpdf   to make LaTeX files and run them through pdflatex" 
     30    @echo "  text       to make text files" 
     31    @echo "  man        to make manual pages" 
     32    @echo "  changes    to make an overview of all changed/added/deprecated items" 
     33    @echo "  linkcheck  to check all external links for integrity" 
     34    @echo "  doctest    to run all doctests embedded in the documentation (if enabled)" 
    2935 
    3036clean: 
    31     -rm -rf _build/* 
     37    -rm -rf $(BUILDDIR)/* 
    3238 
    3339html: 
    34     $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) . 
     40    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    3541    @echo 
    36     @echo "Build finished. The HTML pages are in .. ." 
     42    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 
    3743 
    3844dirhtml: 
    39     $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) .dirhtml 
     45    $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 
    4046    @echo 
    41     @echo "Build finished. The HTML pages are in .dirhtml." 
     47    @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 
     48 
     49singlehtml: 
     50    $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 
     51    @echo 
     52    @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 
    4253 
    4354pickle: 
    44     $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) .pickle 
     55    $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 
    4556    @echo 
    4657    @echo "Build finished; now you can process the pickle files." 
    4758 
    4859json: 
    49     $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) .json 
     60    $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 
    5061    @echo 
    5162    @echo "Build finished; now you can process the JSON files." 
    5263 
    5364htmlhelp: 
    54     $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) .htmlhelp 
     65    $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 
    5566    @echo 
    5667    @echo "Build finished; now you can run HTML Help Workshop with the" \ 
    57           ".hhp project file in .htmlhelp." 
     68          ".hhp project file in $(BUILDDIR)/htmlhelp." 
    5869 
    5970qthelp: 
    60     $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) .qthelp 
     71    $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 
    6172    @echo 
    6273    @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 
    63           ".qhcp project file in .qthelp, like this:" 
    64     @echo "# qcollectiongenerator .qthelp/OrangeWidgetCatalog.qhcp" 
     74          ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 
     75    @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OrangeX.qhcp" 
    6576    @echo "To view the help file:" 
    66     @echo "# assistant -collectionFile .qthelp/OrangeWidgetCatalog.qhc" 
     77    @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OrangeX.qhc" 
     78 
     79devhelp: 
     80    $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 
     81    @echo 
     82    @echo "Build finished." 
     83    @echo "To view the help file:" 
     84    @echo "# mkdir -p $$HOME/.local/share/devhelp/OrangeX" 
     85    @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OrangeX" 
     86    @echo "# devhelp" 
     87 
     88epub: 
     89    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 
     90    @echo 
     91    @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 
    6792 
    6893latex: 
    69     $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) .latex 
     94    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    7095    @echo 
    71     @echo "Build finished; the LaTeX files are in .latex." 
    72     @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ 
    73           "run these through (pdf)latex." 
     96    @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 
     97    @echo "Run \`make' in that directory to run these through (pdf)latex" \ 
     98          "(use \`make latexpdf' here to do that automatically)." 
     99 
     100latexpdf: 
     101    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
     102    @echo "Running LaTeX files through pdflatex..." 
     103    make -C $(BUILDDIR)/latex all-pdf 
     104    @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 
     105 
     106text: 
     107    $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 
     108    @echo 
     109    @echo "Build finished. The text files are in $(BUILDDIR)/text." 
     110 
     111man: 
     112    $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 
     113    @echo 
     114    @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 
    74115 
    75116changes: 
    76     $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) .changes 
     117    $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 
    77118    @echo 
    78     @echo "The overview file is in .changes." 
     119    @echo "The overview file is in $(BUILDDIR)/changes." 
    79120 
    80121linkcheck: 
    81     $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) .linkcheck 
     122    $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
    82123    @echo 
    83124    @echo "Link check complete; look for any errors in the above output " \ 
    84           "or in .linkcheck/output.txt." 
     125          "or in $(BUILDDIR)/linkcheck/output.txt." 
    85126 
    86127doctest: 
    87     $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) .doctest 
     128    $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 
    88129    @echo "Testing of doctests in the sources finished, look at the " \ 
    89           "results in .doctest/output.txt." 
     130          "results in $(BUILDDIR)/doctest/output.txt." 
Note: See TracChangeset for help on using the changeset viewer.