New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Changeset 11713 for NEMO/trunk/doc/rst/Makefile – NEMO

Ignore:
Timestamp:
2019-10-17T17:49:19+02:00 (5 years ago)
Author:
nicolasmartin
Message:

Revamp TOP README and implement a TODO list
Review tracers.rst by adding snippets of source files
Add drafthtml target for Makefile related to draft building tag for sphinx-build to
display todo items at the top of the guide homepage

Misc:

  • Use dedicated :file: role instead of ... for file or directory
  • Update BibTeX entries of NEMO reference publications by using :title: role
  • Dump of RELEASE_NOTES.rst
  • New file todos.rst to list all items declared with todo directive
  • Modify conf.py to add a conditional test for draft tag
File:
1 edited

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/doc/rst/Makefile

    r11706 r11713  
    1515I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 
    1616 
    17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 
     17.PHONY: help clean html dirhtml drafthtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 
    1818 
    1919help: 
    … …  
    2121   @echo "  html       to make standalone HTML files" 
    2222   @echo "  dirhtml    to make HTML files named index.html in directories" 
     23   @echo "  drafthtml  to make an autoupdate HTML export while editing (todo list included)" 
    2324   @echo "  singlehtml to make a single large HTML file" 
    24    @echo "  livehtml   to make an autoupdate HTML export while editing" 
    2525   @echo "  pickle     to make pickle files" 
    2626   @echo "  json       to make JSON files" 
    … …  
    4444 
    4545html: 
    46    $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
     46   $(SPHINXBUILD)   -b html          $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    4747   @echo 
    4848   @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 
    4949 
    5050dirhtml: 
    51    $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 
     51   $(SPHINXBUILD)   -b dirhtml      $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 
    5252   @echo 
    5353   @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 
    5454 
     55drafthtml: 
     56   sphinx-autobuild -b html -t draft $(ALLSPHINXOPTS) $(BUILDDIR)/drafthtml 
     57   @echo 
     58   @echo "Build finished. The HTML pages are in $(BUILDDIR)/drafthtml." 
     59 
    5560singlehtml: 
    56    $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 
     61   $(SPHINXBUILD)   -b singlehtml    $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 
    5762   @echo 
    5863   @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 
    5964 
    60 livehtml: 
    61    sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 
    62    @echo 
    63    @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 
    64  
    6565pickle: 
    66    $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 
     66   $(SPHINXBUILD)   -b pickle        $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 
    6767   @echo 
    6868   @echo "Build finished; now you can process the pickle files." 
    6969 
    7070json: 
    71    $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 
     71   $(SPHINXBUILD)   -b json          $(ALLSPHINXOPTS) $(BUILDDIR)/json 
    7272   @echo 
    7373   @echo "Build finished; now you can process the JSON files." 
    7474 
    7575htmlhelp: 
    76    $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 
     76   $(SPHINXBUILD)   -b htmlhelp      $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 
    7777   @echo 
    7878   @echo "Build finished; now you can run HTML Help Workshop with the" \ 
    … …  
    8080 
    8181qthelp: 
    82    $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 
     82   $(SPHINXBUILD)   -b qthelp        $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 
    8383   @echo 
    8484   @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 
    … …  
    8989 
    9090devhelp: 
    91    $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 
     91   $(SPHINXBUILD)   -b devhelp      $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 
    9292   @echo 
    9393   @echo "Build finished." 
    … …  
    9898 
    9999epub: 
    100    $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 
     100   $(SPHINXBUILD)   -b epub          $(ALLSPHINXOPTS) $(BUILDDIR)/epub 
    101101   @echo 
    102102   @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 
    103103 
    104104latex: 
    105    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
     105   $(SPHINXBUILD)   -b latex        $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    106106   @echo 
    107107   @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 
    … …  
    110110 
    111111latexpdf: 
    112    $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
     112   $(SPHINXBUILD)   -b latex        $(ALLSPHINXOPTS) $(BUILDDIR)/latex 
    113113   @echo "Running LaTeX files through pdflatex..." 
    114114   $(MAKE) -C $(BUILDDIR)/latex all-pdf 
    … …  
    116116 
    117117text: 
    118    $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 
     118   $(SPHINXBUILD)   -b text          $(ALLSPHINXOPTS) $(BUILDDIR)/text 
    119119   @echo 
    120120   @echo "Build finished. The text files are in $(BUILDDIR)/text." 
    121121 
    122122man: 
    123    $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 
     123   $(SPHINXBUILD)   -b man          $(ALLSPHINXOPTS) $(BUILDDIR)/man 
    124124   @echo 
    125125   @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 
    126126 
    127127texinfo: 
    128    $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 
     128   $(SPHINXBUILD)   -b texinfo      $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 
    129129   @echo 
    130130   @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 
    … …  
    133133 
    134134info: 
    135    $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 
     135   $(SPHINXBUILD)   -b texinfo      $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 
    136136   @echo "Running Texinfo files through makeinfo..." 
    137137   make -C $(BUILDDIR)/texinfo info 
    … …  
    139139 
    140140gettext: 
    141    $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 
     141   $(SPHINXBUILD)   -b gettext      $(I18NSPHINXOPTS) $(BUILDDIR)/locale 
    142142   @echo 
    143143   @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 
    144144 
    145145changes: 
    146    $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 
     146   $(SPHINXBUILD)   -b changes      $(ALLSPHINXOPTS) $(BUILDDIR)/changes 
    147147   @echo 
    148148   @echo "The overview file is in $(BUILDDIR)/changes." 
    149149 
    150150linkcheck: 
    151    $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
     151   $(SPHINXBUILD)   -b linkcheck    $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 
    152152   @echo 
    153153   @echo "Link check complete; look for any errors in the above output " \ 
    … …  
    155155 
    156156doctest: 
    157    $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 
     157   $(SPHINXBUILD)   -b doctest      $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 
    158158   @echo "Testing of doctests in the sources finished, look at the " \ 
    159159         "results in $(BUILDDIR)/doctest/output.txt." 
Note: See TracChangeset for help on using the changeset viewer.