source: NEMO/trunk/doc/rst/Makefile @ 10991

Last change on this file since 10991 was 10990, checked in by nicolasmartin, 2 years ago

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.

File size: 807 bytes
Line 
1# Minimal makefile for Sphinx documentation
2#
3
4# You can set these variables from the command line.
5SPHINXOPTS    =
6SPHINXBUILD   = sphinx-build
7SPHINXPROJ    = NEMO
8SOURCEDIR     = source
9BUILDDIR      = build
10
11# Put it first so that "make" without argument is like "make help".
12help:
13   @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
15.PHONY: help Makefile
16
17# Catch-all target: route all unknown targets to Sphinx using the new
18# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
19%: Makefile
20   @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21
22# Watch source directory and rebuild the documentation when a change is detected
23# Browse to 127.0.0.1:8000/NEMO_guide.html
24htmllive:
25   sphinx-autobuild $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/htmllive
Note: See TracBrowser for help on using the repository browser.