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 – NEMO
wiki:Developers/Update_onLine_UsersGuide

Version 2 (modified by clevy, 3 years ago) (diff)

--

Update on line Users guide

Last edition: Wikinfo(changed_ts)? by Wikinfo(changed_by)?

When 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.

These 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

Installalling sphinx on apple IOS using macports

sudo port install py38-sphinx
sudo port -f activate python38
sudo port select --set python python38
sudo port install py38-sphinx
sudo port select --set sphinx py38-sphinx
sudo port select --set pygments py38-pygments
sudo port reclaim 
sudo port install py38-sphinx_rtd_theme

To generate the hmtl, as described in the README file, run:

cd doc/rst
make html

The html files are genreated in build/html directory This newly generated html directy needs to be copied in

nemo@forge.ipsl.jussieu.fr:/ipsl/forge/projets/nemo/trac/htdocs/doc/NEMO/guide

to be visible in the trac pages Users guide.