Changeset 11713 for NEMO/trunk/doc/rst/source/conf.py

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/conf.py (modified) (3 diffs)

NEMO/trunk/doc/rst/source/conf.py

@@ -26 +26 @@
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex', 'sphinx.ext.todo']
+extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex', 'sphinx.ext.todo', 'sphinxmark']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -251 +251 @@
 # Link aliases
 extlinks = {
-   'doi'    : ('https://doi.org/%s'                       , None),
-   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'    , None),
-   'github' : ('https://github.com/%s'                    , None),
-   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s', None),
-   'website': ('https://www.nemo-ocean.eu/%s'             , None),
-   'zenodo' : ('https://zenodo.org/publication/%s'        , None)
+   'doi'    : ('https://doi.org/%s'                       , 'doi:'),
+   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'    ,   None),
+   'github' : ('https://github.com/%s'                    ,   None),
+   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s',   None),
+   'website': ('https://www.nemo-ocean.eu/%s'             ,   None),
+   'zenodo' : ('https://zenodo.org/publication/%s'        ,   None)
 }
 
@@ -266 +266 @@
 revision = subprocess.check_output("svnversion").decode("utf-8")
 rst_prolog = '.. |revision| replace:: %s' % revision
+
+# Todo
+if tags.has('draft'):
+    sphinxmark_enable = True
+    todo_include_todos = True
+    todo_emit_warnings = True