Changeset 11718

Timestamp:

2019-10-18T12:03:11+02:00 (4 years ago)

Author:

nicolasmartin

Message:

Rename symlinks to rst files
Shortening the internal link syntax with :doc: and making it much readable

Location:

NEMO/trunk/doc/rst/source

Files:

• acro.rst (moved) (moved from NEMO/trunk/doc/rst/source/glossary.rst) (1 diff)
• cfgs.bib (moved) (moved from NEMO/trunk/doc/rst/source/configurations.bib)
• cfgs.rst (moved) (moved from NEMO/trunk/doc/rst/source/configurations.rst)
• changes.rst (added)
• cite.rst (moved) (moved from NEMO/trunk/doc/rst/source/citations.rst) (3 diffs)
• conf.py (modified) (7 diffs)
• contrib.rst (moved) (moved from NEMO/trunk/doc/rst/source/contributing.rst)
• cplg.rst (moved) (moved from NEMO/trunk/doc/rst/source/coupling.rst)
• crs.rst (moved) (moved from NEMO/trunk/doc/rst/source/coarsening.rst)
• da.rst (moved) (moved from NEMO/trunk/doc/rst/source/data_assimilation.rst)
• diags.rst (moved) (moved from NEMO/trunk/doc/rst/source/diagnostics.rst)
• doc.rst (added)
• global.rst (modified) (1 diff)
• guide.rst (moved) (moved from NEMO/trunk/doc/rst/source/NEMO_guide.rst) (5 diffs)
• ref.bib (moved) (moved from NEMO/trunk/doc/rst/source/references.bib)
• release_notes.rst (deleted)
• src.rst (added)
• tests.bib (moved) (moved from NEMO/trunk/doc/rst/source/test_cases.bib)
• tests.rst (moved) (moved from NEMO/trunk/doc/rst/source/test_cases.rst)
• todos.rst (modified) (1 diff)

NEMO/trunk/doc/rst/source/acro.rst

@@ -1 +1 @@
 ********
-Glossary
+Acronyms
 ********
 

NEMO/trunk/doc/rst/source/cite.rst

@@ -10 +10 @@
    :doi:`10.5281/zenodo.1464816`
 
-.. literalinclude:: references.bib
+.. literalinclude:: ref.bib
    :language: bibtex
    :lines:    1-9
@@ -25 +25 @@
 .. warning::  No official publication yet
 
-.. literalinclude:: references.bib
+.. literalinclude:: ref.bib
    :language: bibtex
    :lines:    13-21
@@ -39 +39 @@
 .. warning::  No official publication yet
 
-.. literalinclude:: references.bib
+.. literalinclude:: ref.bib
    :language: bibtex
    :lines:    25-33

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', 'sphinxmark']
+extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex', 'sphinx.ext.todo']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -38 +38 @@
 
 # The master toctree document.
-master_doc = 'NEMO_guide'
+master_doc = 'guide'
 
 # General information about the project.
@@ -65 +65 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['global.rst', 'coarsening.rst']
+exclude_patterns = ['global.rst', 'crs.rst']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
@@ -184 +184 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('NEMO_guide', 'NEMO_guide.tex', u'NEMO Quick Start Guide',
+  ('guide', 'guide.tex', u'NEMO Quick Start Guide',
    u'NEMO Consortium', 'howto'),
 ]
@@ -214 +214 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('NEMO_guide', 'nemo', u'NEMO Documentation',
+    ('guide', 'nemo', u'NEMO Documentation',
      [u'NEMO System Team'], 1)
 ]
@@ -228 +228 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('NEMO_guide', 'NEMO', u'NEMO Documentation',
+  ('guide', 'NEMO', u'NEMO Documentation',
    u'NEMO System Team', 'NEMO', 'One line description of project.',
    'Miscellaneous'),
@@ -267 +267 @@
 rst_prolog = '.. |revision| replace:: %s' % revision
 
-# Todo
+# 'draft' build tag: DRAFT watermark and TODO list
 if tags.has('draft'):
-    sphinxmark_enable = True
     todo_include_todos = True
     todo_emit_warnings = True

NEMO/trunk/doc/rst/source/global.rst

@@ -39 +39 @@
 .. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html
 .. _BFM man: https://cmcc-foundation.github.io/www.bfm-community.eu/files/bfm-nemo-manual_r1.0_201508.pdf
+.. _RST man: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
 
 .. DOI

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

@@ -20 +20 @@
 
    install
-   configurations
-   test_cases
+   cfgs
+   tests
 
 .. toctree::
@@ -28 +28 @@
 
    setup
-   diagnostics
+   dia
    tools
 
@@ -36 +36 @@
 
    zooms
-   coupling
-   data_assimilation
+   cplg
+   da
    tracers
 
@@ -44 +44 @@
    :caption: Miscellaneous
 
-   citations
-   contributing
-   release_notes
-   glossary
+   cite
+   contrib
+   changes
+   acro
 
 :Release:  |release|
@@ -53 +53 @@
 .. only:: draft
 
+   :*Date*:     |today|
+   :*SVN rev*:  |revision|
+
    .. include:: todos.rst
 

NEMO/trunk/doc/rst/source/todos.rst

@@ -1 +1 @@
 .. rubric:: List of editing tasks
 
-:*Date*:     |today|
-:*SVN rev*:  |revision|
-
 .. todolist::