Changeset 11713 for NEMO/trunk/doc/rst/source/NEMO_guide.rst

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:

• NEMO/trunk/doc/rst/source/NEMO_guide.rst (modified) (2 diffs)

NEMO/trunk/doc/rst/source/NEMO_guide.rst

@@ -12 +12 @@
    ", for paragraphs
 
-   'global.rst' contains a list of common directives (roles, substitutions and URL links)
-   It is loaded for each file thanks to 'rst_epilog' setting in 'conf.py'
+   'global.rst' contains a list of roles, substitutions and URL links for the guide.
+   It is loaded for each file with the 'rst_epilog' setting in 'conf.py'
 
 .. toctree::
@@ -49 +49 @@
    glossary
 
+:Release:  |release|
+
+.. only:: draft
+
+   .. include:: todos.rst
+
 .. include:: readme.rst
-
-.. Next headings markup acording to readme.rst
-
-Disclaimer
-==========
-
-The NEMO source code is freely available and distributed under CeCILL license
-(GNU GPL compatible - see ``./LICENSE``).
-
-You can use, modify and/or redistribute the software under its terms,
-but users are provided only with a limited warranty and the software's authors and
-the successive licensor's have only limited liability.