Ignore:
Timestamp:
2018-11-07T12:04:15+01:00 (2 years ago)
Author:
nicolasmartin
Message:

Various improvments for quick start guide

  • implementation of Rtd theme (Read the Docs) with custom layout and style file
  • add reviewed BibTeX entries for NEMO references with DOI (manuals, guide, development strategy)
  • enhancement of bibliography management and configuration file for guide building
  • standardisation of headings markup
  • numerous edits
File:
1 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/rst/source/conf.py

    r10201 r10279  
    2121 
    2222project = 'NEMO' 
    23 copyright = '2018, NEMO System Team' 
     23copyright = '' 
    2424author = 'NEMO System Team' 
    2525 
     
    3939# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 
    4040# ones. 
    41 extensions = ['sphinxcontrib.bibtex'] 
     41extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex'] 
    4242 
    4343# Add any paths that contain templates here, relative to this directory. 
     
    6363# directories to ignore when looking for source files. 
    6464# This pattern also affects html_static_path and html_extra_path . 
    65 exclude_patterns = [] 
     65exclude_patterns = ['global.rst'] 
    6666 
    6767# The name of the Pygments (syntax highlighting) style to use. 
     
    7474# a list of builtin themes. 
    7575# 
    76 html_theme = 'alabaster' 
     76#html_theme = 'alabaster' 
     77html_theme = 'sphinx_rtd_theme' 
    7778 
    7879# Theme options are theme-specific and customize the look and feel of a theme 
     
    8182# 
    8283html_theme_options = { 
    83     'logo': 'NEMO_grey.png', 
    84     'description': 'Community ocean model for multifarious space and time scales', 
    85     'fixed_sidebar': 'true', 
    86 #    'github_user': 'NEMO-ocean', 
    87 #    'github_repo': 'NEMO-examples', 
    88 #    'github_button': 'true', 
    89 #    'github_banner': 'true' 
     84#  Alabaster theme options 
     85#  'logo': 'NEMO_grey.png', 
     86#  'description': 'Community ocean model for multifarious space and time scales', 
     87#  'fixed_sidebar': True, 
    9088} 
    9189 
     
    162160     'Miscellaneous'), 
    163161] 
     162 
     163 
     164# -- Customisation ----------------------------------------------------------- 
     165 
     166import datetime 
     167year = datetime.date.today().year 
     168copyright = '2008-' + str( year ) + ', NEMO Consortium' 
     169 
     170# Link aliases 
     171extlinks = { 
     172   'doi'    : ('http://doi.org/%s'                       , None), 
     173   'forge'  : ('http://forge.ipsl.jussieu.fr/nemo/%s'    , None), 
     174   'github' : ('http://github.com/%s'                    , None), 
     175   'xios'   : ('http://forge.ipsl.jussieu.fr/ioserver/%s', None), 
     176   'website': ('http://www.nemo-ocean.eu/%s'             , None), 
     177   'zenodo' : ('http://zenodo.org/publication/%s'        , None) 
     178} 
     179 
     180# Include common directives for every rst file 
     181rst_epilog = open('global.rst', 'r').read() 
Note: See TracChangeset for help on using the changeset viewer.