New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Developers/Update_onLine_UsersGuide (diff) – NEMO

Changes between Version 1 and Version 2 of Developers/Update_onLine_UsersGuide


Ignore:
Timestamp:
2020-10-31T15:16:29+01:00 (4 years ago)
Author:
clevy
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Developers/Update_onLine_UsersGuide

    v1 v2  
    55When a new minor or major release is announced, some updates are needed in the online users guide: https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/guide/html/NEMO_guide.html, at least to change the release number in the svn checout command, or to update the link to input files of reference confiurations on zenodo, amongst other things. 
    66 
    7 These Users guide pages are html pages generated from the rst files stores in doc/rst/sources in the NEMO repository. 
     7These Users guide pages are html pages generated from the rst files using sphix software. THe rst files are un the NEMO repository  in doc/rst/sources. A README.rst files is available there 
     8 
     9== Installalling sphinx on apple IOS using macports == 
     10 
     11{{{ 
     12sudo port install py38-sphinx 
     13sudo port -f activate python38 
     14sudo port select --set python python38 
     15sudo port install py38-sphinx 
     16sudo port select --set sphinx py38-sphinx 
     17sudo port select --set pygments py38-pygments 
     18sudo port reclaim  
     19sudo port install py38-sphinx_rtd_theme 
     20 
     21}}} 
     22To generate the hmtl, as described in the README file, run: 
     23{{{ 
     24cd doc/rst 
     25make html 
     26}}} 
     27 
     28The html files are genreated in build/html directory 
     29This newly generated  html directy needs to be copied in 
     30{{{ 
     31nemo@forge.ipsl.jussieu.fr:/ipsl/forge/projets/nemo/trac/htdocs/doc/NEMO/guide 
     32}}} 
     33to be visible in the trac pages Users guide.