Ignore:
Timestamp:
2019-10-17T17:49:19+02:00 (14 months 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/source/NEMO_guide.rst

    r11707 r11713  
    1212   ", for paragraphs 
    1313 
    14    'global.rst' contains a list of common directives (roles, substitutions and URL links) 
    15    It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py' 
     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' 
    1616 
    1717.. toctree:: 
     
    4949   glossary 
    5050 
     51:Release:  |release| 
     52 
     53.. only:: draft 
     54 
     55   .. include:: todos.rst 
     56 
    5157.. include:: readme.rst 
    52  
    53 .. Next headings markup acording to readme.rst 
    54  
    55 Disclaimer 
    56 ========== 
    57  
    58 The NEMO source code is freely available and distributed under CeCILL license 
    59 (GNU GPL compatible - see ``./LICENSE``). 
    60  
    61 You can use, modify and/or redistribute the software under its terms, 
    62 but users are provided only with a limited warranty and the software's authors and 
    63 the successive licensor's have only limited liability. 
Note: See TracChangeset for help on using the changeset viewer.