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.
#2463 (Updating the online quickstart guide) – NEMO

Opened 4 years ago

Last modified 4 years ago

#2463 new Defect

Updating the online quickstart guide

Reported by: clevy Owned by: systeam
Priority: normal Milestone:
Component: doc Version: v4.0.*
Severity: major Keywords:
Cc:

Description (last modified by clevy)

Context

Online quickstart guide is here https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/guide/html/NEMO_guide.html and need updates.

Analysis

Using the donc/rst files, compile them (make html) to generate html files from the rst ones, and place these updated html directory in place on NEMO forge.

Recommendations and questions

  • Do you agree to do it from the rst files from the trunk?
  • Which rst files need update? Who is willing to do these updates?
  • Do you have any idea on how to deal with the warning (see below)?

Warnings:

/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/acro.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/cite.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/contrib.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/da.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/diags.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/guide.rst:16: WARNING: toctree contains reference to excluded document 'todos'
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/guide.rst:23: WARNING: toctree glob pattern 'unpub/*' didn't match any documents
source/readme.rst:1: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/install.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/setup.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/tests.rst:: WARNING: image file not readable: _static/CANAL_image.gif
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/tools.rst:45: WARNING: download file not readable: /Users/clelod/Documents/WORK/TEX/trunk/tools/DOMAINcfg/README
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/tracers.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst:5: WARNING: Content block expected for the "todo" directive; none found.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst:13: WARNING: duplicate label overview, other instance in /Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/guide.rst
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst:26: WARNING: duplicate label compilation, other instance in /Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/tests.rst
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/tests.rst: WARNING: Citation [Brodeau_al_2017] is not referenced.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst: WARNING: Citation [a-DEBREU2012] is not referenced.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst: WARNING: Citation [a-PENVEN2006] is not referenced.
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/zooms.rst: WARNING: Citation [a-SPALL1991] is not referenced.
done
preparing documents... done
writing output... [100%] zooms
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/install.rst:135: WARNING: unknown document: doc
/Users/clelod/Documents/WORK/TEX/trunk/doc/rst/source/install.rst:142: WARNING: unknown document: src
generating indices... genindexdone
writing additional pages... searchdone
copying images... [100%] _static/agrif_grid_position.jpg
copying downloadable files... [100%] ../../../tools/WEIGHTS/README
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 22 warnings.

The HTML pages are in build/html.

Build finished. The HTML pages are in build/html.

Commit History (0)

(No commits)

Change History (1)

comment:1 Changed 4 years ago by clevy

  • Description modified (diff)
  • Priority changed from low to normal
  • Severity changed from minor to major
Note: See TracTickets for help on using tickets.