Changeset 10990

Timestamp:

2019-05-16T21:07:17+02:00 (6 years ago)

Author:

nicolasmartin

Message:

Global review of the building and editing operations on NEMO guide

• Addition of README.rst for users and editors
• Waiver of the use of requirements_* files for the installation of Python dependencies, instead run the following commands
  • pip install sphinx sphinxcontrib.bibtex sphinx_rtd_theme for building and offline editing (make html )
  • pip install sphinx-autobuild for online editing on local server (make htmllive)
• Put offline and online editing builds in distinct folders to prevent confusion and provide a backup for comparison
  • make html -> ./build/html
  • make htmllive -> ./build/htmllive
• Fix a coding issue in conf.py to display a clean revision number

Due to the state of the forge server (deprecated Python 3 library),
the guide builded internally does not have the expected rendering and
thus can not be made available to users in this version.
As a consequence, the online version of the guide will be updated upon request and
imported from a external build.

Location:

NEMO/trunk/doc/rst

Files:

• Makefile (modified) (1 diff)
• README.rst (added)
• requirements_make_html.txt (deleted)
• requirements_make_htmllive.txt (deleted)
• source/conf.py (modified) (1 diff)

NEMO/trunk/doc/rst/Makefile

@@ -23 +23 @@
 # Browse to 127.0.0.1:8000/NEMO_guide.html
 htmllive:
-   sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
+   sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/htmllive

NEMO/trunk/doc/rst/source/conf.py

@@ -112 +112 @@
 # SVN revision
 import subprocess
-revision = subprocess.check_output("svnversion")
+revision = subprocess.check_output("svnversion").decode("utf-8")
 rst_prolog = '.. |svn_revision| replace:: %s' % revision