CoreFlows/gui/doc/documentation.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4 .. _iraDocumentation:
   5
   6 ************************************
   7 Documentation
   8 ************************************
   9
  10 .. _iraDocumentation_consultation:
  11
  12
  13 Doc consultation
  14 =================
  15
  16 To display solverlabGUI html documentation in your web browser *firefox*, or *else*.
  17 The initial entry file is located at *solverlabGUI/doc/build/html/index.html*.
  18
  19 .. code-block:: bash
  20
  21   # Linux bash, as an example
  22   cd .../solverlabGUI
  23   firefox doc/build/html/index.html &
  24   # or as CLI_
  25   solverlabGUI --doc
  26
  27 .. _iraDocumentation_modification:
  28
  29 Doc modification
  30 =================
  31
  32 To modify solverlabGUI documentation with simple editor *pluma*, or else.
  33
  34 Read the manual, see http://www.sphinx-doc.org/en/stable/tutorial.html,
  35 or may be copy/paste from 'Show Source' item.
  36
  37 .. code-block:: bash
  38
  39   # Linux bash, as an example
  40   cd ...solverlabGUI/
  41   tmp=$(find doc -name "*.rst")
  42   pluma $tmp &
  43
  44
  45 .. _iraDocumentation_compilation:
  46
  47 Doc compilation Linux
  48 ======================
  49
  50 On a Linux system, to compile solverlabGUI html documentation,
  51 programmers use installed GNU_ *make*, and SPHINX_.
  52
  53 .. warning:: To make documentation **pdf** programmers needs
  54              installed *texlive* package (preferably up to date version).
  55              See: https://www.tug.org/texlive/quickinstall.html
  56
  57
  58 .. code-block:: text
  59
  60   cd ...solverlabGUI/doc
  61   cat README  # read some environment setup information
  62   #  ... and read it
  63   make
  64     Please use `make <target>' where <target> is one of
  65     html       to make standalone HTML files
  66     dirhtml    to make HTML files named index.html in directories
  67     singlehtml to make a single large HTML file
  68     pickle     to make pickle files
  69     json       to make JSON files
  70     htmlhelp   to make HTML files and a HTML help project
  71     qthelp     to make HTML files and a qthelp project
  72     devhelp    to make HTML files and a Devhelp project
  73     epub       to make an epub
  74     latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  75     latexpdf   to make LaTeX files and run them through pdflatex
  76     text       to make text files
  77     man        to make manual pages
  78     changes    to make an overview of all changed/added/deprecated items
  79     linkcheck  to check all external links for integrity
  80     doctest    to run all doctests embedded in the documentation (if enabled)
  81
  82   # and then
  83   make html      # make html doc
  84   make latexpdf  # make pdf doc
  85
  86
  87
  88