Changes between Version 1 and Version 2 of Developers/Update_onLine_UsersGuide
- Timestamp:
- 2020-10-31T15:16:29+01:00 (4 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Developers/Update_onLine_UsersGuide
v1 v2 5 5 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. 6 6 7 These Users guide pages are html pages generated from the rst files stores in doc/rst/sources in the NEMO repository. 7 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 8 9 == Installalling sphinx on apple IOS using macports == 10 11 {{{ 12 sudo port install py38-sphinx 13 sudo port -f activate python38 14 sudo port select --set python python38 15 sudo port install py38-sphinx 16 sudo port select --set sphinx py38-sphinx 17 sudo port select --set pygments py38-pygments 18 sudo port reclaim 19 sudo port install py38-sphinx_rtd_theme 20 21 }}} 22 To generate the hmtl, as described in the README file, run: 23 {{{ 24 cd doc/rst 25 make html 26 }}} 27 28 The html files are genreated in build/html directory 29 This newly generated html directy needs to be copied in 30 {{{ 31 nemo@forge.ipsl.jussieu.fr:/ipsl/forge/projets/nemo/trac/htdocs/doc/NEMO/guide 32 }}} 33 to be visible in the trac pages Users guide.