Changeset 10590


Ignore:
Timestamp:
2019-01-28T15:21:15+01:00 (18 months ago)
Author:
nicolasmartin
Message:

Shrink sphinx conf file and publish CONTRIBUTING file

Location:
NEMO/trunk/doc/rst/source
Files:
1 added
2 edited

Legend:

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

    r10460 r10590  
    4646 
    4747.. toctree:: 
     48   :hidden: 
     49   :caption: Contributions are welcome! 
     50 
     51   contributing 
     52 
     53.. toctree:: 
    4854   :hidden: 
    4955   :caption: Glossary 
  • NEMO/trunk/doc/rst/source/conf.py

    r10460 r10590  
    77# http://www.sphinx-doc.org/en/master/config 
    88 
    9 # -- Path setup -------------------------------------------------------------- 
    10  
    11 # If extensions (or modules to document with autodoc) are in another directory, 
    12 # add these directories to sys.path here. If the directory is relative to the 
    13 # documentation root, use os.path.abspath to make it absolute, like shown here. 
    14 # 
    15 # import os 
    16 # import sys 
    17 # sys.path.insert(0, os.path.abspath('.')) 
    18  
    19  
    209# -- Project information ----------------------------------------------------- 
    2110 
    2211project = 'NEMO' 
    23 copyright = '' 
    2412author = 'NEMO System Team' 
    2513 
     
    2715version = '4.0' 
    2816# The full version, including alpha/beta/rc tags 
    29 release = '4.0rc' 
     17release = '4.0.0' 
    3018 
    3119 
    3220# -- General configuration --------------------------------------------------- 
    33  
    34 # If your documentation needs a minimal Sphinx version, state it here. 
    35 # 
    36 # needs_sphinx = '1.0' 
    3721 
    3822# Add any Sphinx extension module names here, as strings. They can be 
     
    4125extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex'] 
    4226 
    43 # Add any paths that contain templates here, relative to this directory. 
    44 templates_path = ['_templates'] 
    45  
    46 # The suffix(es) of source filenames. 
    47 # You can specify multiple suffix as a list of string: 
    48 # 
    49 # source_suffix = ['.rst', '.md'] 
    50 source_suffix = '.rst' 
    51  
    5227# The master toctree document. 
    5328master_doc = 'NEMO_guide' 
    54  
    55 # The language for content autogenerated by Sphinx. Refer to documentation 
    56 # for a list of supported languages. 
    57 # 
    58 # This is also used if you do content translation via gettext catalogs. 
    59 # Usually you set "language" from the command line for these cases. 
    60 language = None 
    6129 
    6230# List of patterns, relative to source directory, that match files and 
     
    7442# a list of builtin themes. 
    7543# 
    76 #html_theme = 'alabaster' 
    7744html_theme = 'sphinx_rtd_theme' 
    7845 
     
    8148# documentation. 
    8249# 
    83 html_theme_options = { 
    84 #  Alabaster theme options 
    85 #  'logo': 'NEMO_grey.png', 
    86 #  'description': 'Community ocean model for multifarious space and time scales', 
    87 #  'fixed_sidebar': True, 
    88 } 
     50html_theme_options = {} 
    8951 
    9052# Add any paths that contain custom static files (such as style sheets) here, 
     
    9355html_static_path = ['_static'] 
    9456 
    95 # Custom sidebar templates, must be a dictionary that maps document names 
    96 # to template names. 
    97 # 
    98 # The default sidebars (for documents that don't match any pattern) are 
    99 # defined by theme itself.  Builtin themes are using these templates by 
    100 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', 
    101 # 'searchbox.html']``. 
    102 # 
    103 # html_sidebars = {} 
    104  
    10557html_favicon = '_static/ORCA.ico' 
    106  
    107 # -- Options for HTMLHelp output --------------------------------------------- 
    108  
    109 # Output file base name for HTML help builder. 
    110 htmlhelp_basename = 'NEMOdoc' 
    11158 
    11259 
     
    14087 
    14188 
    142 # -- Options for manual page output ------------------------------------------ 
    143  
    144 # One entry per manual page. List of tuples 
    145 # (source start file, name, description, authors, manual section). 
    146 man_pages = [ 
    147     (master_doc, 'nemo', 'NEMO Documentation', 
    148      [author], 1) 
    149 ] 
    150  
    151  
    152 # -- Options for Texinfo output ---------------------------------------------- 
    153  
    154 # Grouping the document tree into Texinfo files. List of tuples 
    155 # (source start file, target name, title, author, 
    156 #  dir menu entry, description, category) 
    157 texinfo_documents = [ 
    158     (master_doc, 'NEMO', 'NEMO Documentation', 
    159      author, 'NEMO', 'One line description of project.', 
    160      'Miscellaneous'), 
    161 ] 
    162  
    163  
    16489# -- Customisation ----------------------------------------------------------- 
    16590 
     
    17095# Link aliases 
    17196extlinks = { 
    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) 
     97   'doi'    : ('https://doi.org/%s'                       , None), 
     98   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'    , None), 
     99   'github' : ('https://github.com/%s'                    , None), 
     100   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s', None), 
     101   'website': ('https://www.nemo-ocean.eu/%s'             , None), 
     102   'zenodo' : ('https://zenodo.org/publication/%s'        , None) 
    178103} 
    179104 
Note: See TracChangeset for help on using the changeset viewer.