Changeset 10990


Ignore:
Timestamp:
2019-05-16T21:07:17+02:00 (18 months 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:
1 added
2 deleted
2 edited

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/rst/Makefile

    r10604 r10990  
    2323# Browse to 127.0.0.1:8000/NEMO_guide.html 
    2424htmllive: 
    25    sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html 
     25   sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/htmllive 
  • NEMO/trunk/doc/rst/source/conf.py

    r10790 r10990  
    112112# SVN revision 
    113113import subprocess 
    114 revision = subprocess.check_output("svnversion") 
     114revision = subprocess.check_output("svnversion").decode("utf-8") 
    115115rst_prolog = '.. |svn_revision| replace:: %s' % revision 
Note: See TracChangeset for help on using the changeset viewer.