Changeset 11718


Ignore:
Timestamp:
2019-10-18T12:03:11+02:00 (11 months 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:
3 added
1 deleted
3 edited
13 moved

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/rst/source/acro.rst

    r11713 r11718  
    11******** 
    2 Glossary 
     2Acronyms 
    33******** 
    44 
  • NEMO/trunk/doc/rst/source/cite.rst

    r11713 r11718  
    1010   :doi:`10.5281/zenodo.1464816` 
    1111 
    12 .. literalinclude:: references.bib 
     12.. literalinclude:: ref.bib 
    1313   :language: bibtex 
    1414   :lines:    1-9 
     
    2525.. warning::  No official publication yet 
    2626 
    27 .. literalinclude:: references.bib 
     27.. literalinclude:: ref.bib 
    2828   :language: bibtex 
    2929   :lines:    13-21 
     
    3939.. warning::  No official publication yet 
    4040 
    41 .. literalinclude:: references.bib 
     41.. literalinclude:: ref.bib 
    4242   :language: bibtex 
    4343   :lines:    25-33 
  • NEMO/trunk/doc/rst/source/conf.py

    r11713 r11718  
    2626# Add any Sphinx extension module names here, as strings. They can be extensions 
    2727# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    28 extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex', 'sphinx.ext.todo', 'sphinxmark'] 
     28extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex', 'sphinx.ext.todo'] 
    2929 
    3030# Add any paths that contain templates here, relative to this directory. 
     
    3838 
    3939# The master toctree document. 
    40 master_doc = 'NEMO_guide' 
     40master_doc = 'guide' 
    4141 
    4242# General information about the project. 
     
    6565# List of patterns, relative to source directory, that match files and 
    6666# directories to ignore when looking for source files. 
    67 exclude_patterns = ['global.rst', 'coarsening.rst'] 
     67exclude_patterns = ['global.rst', 'crs.rst'] 
    6868 
    6969# The reST default role (used for this markup: `text`) to use for all documents. 
     
    184184# (source start file, target name, title, author, documentclass [howto/manual]). 
    185185latex_documents = [ 
    186   ('NEMO_guide', 'NEMO_guide.tex', u'NEMO Quick Start Guide', 
     186  ('guide', 'guide.tex', u'NEMO Quick Start Guide', 
    187187   u'NEMO Consortium', 'howto'), 
    188188] 
     
    214214# (source start file, name, description, authors, manual section). 
    215215man_pages = [ 
    216     ('NEMO_guide', 'nemo', u'NEMO Documentation', 
     216    ('guide', 'nemo', u'NEMO Documentation', 
    217217     [u'NEMO System Team'], 1) 
    218218] 
     
    228228#  dir menu entry, description, category) 
    229229texinfo_documents = [ 
    230   ('NEMO_guide', 'NEMO', u'NEMO Documentation', 
     230  ('guide', 'NEMO', u'NEMO Documentation', 
    231231   u'NEMO System Team', 'NEMO', 'One line description of project.', 
    232232   'Miscellaneous'), 
     
    267267rst_prolog = '.. |revision| replace:: %s' % revision 
    268268 
    269 # Todo 
     269# 'draft' build tag: DRAFT watermark and TODO list 
    270270if tags.has('draft'): 
    271     sphinxmark_enable = True 
    272271    todo_include_todos = True 
    273272    todo_emit_warnings = True 
  • NEMO/trunk/doc/rst/source/global.rst

    r11713 r11718  
    3939.. _Special Issue: https://www.geosci-model-dev.net/special_issue40.html 
    4040.. _BFM man: https://cmcc-foundation.github.io/www.bfm-community.eu/files/bfm-nemo-manual_r1.0_201508.pdf 
     41.. _RST man: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html 
    4142 
    4243.. DOI 
  • NEMO/trunk/doc/rst/source/guide.rst

    r11713 r11718  
    2020 
    2121   install 
    22    configurations 
    23    test_cases 
     22   cfgs 
     23   tests 
    2424 
    2525.. toctree:: 
     
    2828 
    2929   setup 
    30    diagnostics 
     30   dia 
    3131   tools 
    3232 
     
    3636 
    3737   zooms 
    38    coupling 
    39    data_assimilation 
     38   cplg 
     39   da 
    4040   tracers 
    4141 
     
    4444   :caption: Miscellaneous 
    4545 
    46    citations 
    47    contributing 
    48    release_notes 
    49    glossary 
     46   cite 
     47   contrib 
     48   changes 
     49   acro 
    5050 
    5151:Release:  |release| 
     
    5353.. only:: draft 
    5454 
     55   :*Date*:     |today| 
     56   :*SVN rev*:  |revision| 
     57 
    5558   .. include:: todos.rst 
    5659 
  • NEMO/trunk/doc/rst/source/todos.rst

    r11713 r11718  
    11.. rubric:: List of editing tasks 
    22 
    3 :*Date*:     |today| 
    4 :*SVN rev*:  |revision| 
    5  
    63.. todolist:: 
Note: See TracChangeset for help on using the changeset viewer.