Changeset 11761

Timestamp:

2019-10-22T12:02:46+02:00 (5 years ago)

Author:

nicolasmartin

Message:

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

Location:

NEMO/trunk

Files:

• doc/README.rst (modified) (1 diff)
• doc/rst/source/conf.py (modified) (2 diffs)
• doc/rst/source/crs.rst (deleted)
• doc/rst/source/doc.rst (deleted)
• doc/rst/source/guide.rst (modified) (2 diffs)
• doc/rst/source/unpub (added)
• doc/rst/source/unpub/crs.rst (added)
• doc/rst/source/unpub/doc.rst (added)
• doc/rst/source/unpub/src.rst (added)
• src/README.rst (moved) (moved from NEMO/trunk/doc/rst/source/src.rst) (1 diff)

NEMO/trunk/doc/README.rst

@@ +1 @@
+**************************
+Building the documentation
+**************************
 
+.. todo::
+
+
+
+:file:`latex`    : LaTeX sources and Latexmk configuration to build reference manuals with :file:`manual_build.sh`
+
+:file:`namelists`: Namelist blocks included in the documentation
+
+:file:`rst`      : |RST man|_ sources and Sphinx configuration to build this guide hereby with :file:`guide_build.sh`
+
+.. |RST man| replace:: reStructuredText (rst)
 
 .. warning::

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

@@ -66 +66 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['global.rst', 'crs.rst']
+exclude_patterns = ['global.rst', 'readme.rst']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
@@ -267 +267 @@
 # SVN revision
 import subprocess
-revision = subprocess.check_output("svnversion").decode("utf-8")
-rst_prolog = '.. |revision| replace:: %s' % revision
+rev = subprocess.check_output("svnversion").decode("utf-8")
+rst_prolog = '.. |revision| replace:: %s' % rev
 
 # 'draft' build tag: DRAFT watermark and TODO list
 if tags.has('draft'):
-    todo_include_todos = True
-    todo_emit_warnings = True
+   todo_include_todos = True
+   todo_emit_warnings = True
+else:
+   exclude_patterns = ['global.rst', 'readme.rst', 'todos.rst', 'unpub*']

NEMO/trunk/doc/rst/source/guide.rst

@@ -3 +3 @@
 #################
 
-..
-   For headings markup, this convention is recommended from Python’s Style Guide
-   # with overline, for parts
-   * with overline, for chapters
-   =, for sections
-   -, for subsections
-   ^, for subsubsections
-   ", for paragraphs
+.. For headings markup, this convention is recommended from Python’s Style Guide
+   # with overline, for parts
+   * with overline, for chapters
+   =, for sections
+   -, for subsections
+   ^, for subsubsections
+   ", for paragraphs
 
-   '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'
+   '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'
 
-.. only:: draft
+.. toctree::
+   :hidden:
 
-   .. toctree::
-      :hidden:
+   todos
 
-      todos
+.. Only displayed with 'make drafthtml'
+
+.. toctree::
+   :hidden:
+   :caption: Unpublished READMEs
+   :glob:
+   :titlesonly:
+
+   unpub/*
+
+.. Only displayed with 'make drafthtml'
 
 .. toctree::
@@ -60 +69 @@
 .. only:: draft
 
+   .. Only on draft
+
    :*Date*:     |today|
    :*SVN rev*:  |revision|

NEMO/trunk/src/README.rst

@@ -8 +8 @@
 
 :file:`ICE`: |NEMO-ICE|
+
 :file:`NST`: AGRIF for embedded zooms
+
 :file:`OCE`: |NEMO-OCE|
+
 :file:`TOP`: |NEMO-MBG|