Changeset 11761


Ignore:
Timestamp:
2019-10-22T12:02:46+02:00 (11 months ago)
Author:
nicolasmartin
Message:

Create unpub folder for unpublished READMEs (displayed with make drafthtml)

Location:
NEMO/trunk
Files:
4 added
2 deleted
3 edited
1 moved

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/README.rst

    r11154 r11761  
     1************************** 
     2Building the documentation 
     3************************** 
    14 
     5.. todo:: 
     6 
     7 
     8 
     9:file:`latex`    : LaTeX sources and Latexmk configuration to build reference manuals with :file:`manual_build.sh` 
     10 
     11:file:`namelists`: Namelist blocks included in the documentation 
     12 
     13:file:`rst`      : |RST man|_ sources and Sphinx configuration to build this guide hereby with :file:`guide_build.sh` 
     14 
     15.. |RST man| replace:: reStructuredText (rst) 
    216 
    317.. warning:: 
  • NEMO/trunk/doc/rst/source/conf.py

    r11759 r11761  
    6666# List of patterns, relative to source directory, that match files and 
    6767# directories to ignore when looking for source files. 
    68 exclude_patterns = ['global.rst', 'crs.rst'] 
     68exclude_patterns = ['global.rst', 'readme.rst'] 
    6969 
    7070# The reST default role (used for this markup: `text`) to use for all documents. 
     
    267267# SVN revision 
    268268import subprocess 
    269 revision = subprocess.check_output("svnversion").decode("utf-8") 
    270 rst_prolog = '.. |revision| replace:: %s' % revision 
     269rev = subprocess.check_output("svnversion").decode("utf-8") 
     270rst_prolog = '.. |revision| replace:: %s' % rev 
    271271 
    272272# 'draft' build tag: DRAFT watermark and TODO list 
    273273if tags.has('draft'): 
    274     todo_include_todos = True 
    275     todo_emit_warnings = True 
     274   todo_include_todos = True 
     275   todo_emit_warnings = True 
     276else: 
     277   exclude_patterns = ['global.rst', 'readme.rst', 'todos.rst', 'unpub*'] 
  • NEMO/trunk/doc/rst/source/guide.rst

    r11752 r11761  
    33################# 
    44 
    5 .. 
    6    For headings markup, this convention is recommended from Python’s Style Guide 
    7    # with overline, for parts 
    8    * with overline, for chapters 
    9    =, for sections 
    10    -, for subsections 
    11    ^, for subsubsections 
    12    ", for paragraphs 
     5.. For headings markup, this convention is recommended from Python’s Style Guide 
     6   # with overline, for parts 
     7   * with overline, for chapters 
     8   =, for sections 
     9   -, for subsections 
     10   ^, for subsubsections 
     11   ", for paragraphs 
    1312 
    14    'global.rst' contains a list of roles, substitutions and URL links for the guide. 
    15    It is loaded for each file with the 'rst_epilog' setting in 'conf.py' 
     13   'global.rst' contains a list of roles, substitutions and URL links for the guide. 
     14   It is loaded for each file with the 'rst_epilog' setting in 'conf.py' 
    1615 
    17 .. only:: draft 
     16.. toctree:: 
     17   :hidden: 
    1818 
    19    .. toctree:: 
    20       :hidden: 
     19   todos 
    2120 
    22       todos 
     21.. Only displayed with 'make drafthtml' 
     22 
     23.. toctree:: 
     24   :hidden: 
     25   :caption: Unpublished READMEs 
     26   :glob: 
     27   :titlesonly: 
     28 
     29   unpub/* 
     30 
     31.. Only displayed with 'make drafthtml' 
    2332 
    2433.. toctree:: 
     
    6069.. only:: draft 
    6170 
     71   .. Only on draft 
     72 
    6273   :*Date*:     |today| 
    6374   :*SVN rev*:  |revision| 
  • NEMO/trunk/src/README.rst

    r11760 r11761  
    88 
    99:file:`ICE`: |NEMO-ICE| 
     10 
    1011:file:`NST`: AGRIF for embedded zooms 
     12 
    1113:file:`OCE`: |NEMO-OCE| 
     14 
    1215:file:`TOP`: |NEMO-MBG| 
Note: See TracChangeset for help on using the changeset viewer.