Warning, /epic-analysis/deps/delphes_EIC/docs/README.rst is written in an unsupported language. File is not indexed.
0001 :orphan:
0002
0003 The documentation is automatically built after commit to master branch.
0004
0005 By default the documentation should be written in reStructuredText. Markdown files are acceptible also but have limited
0006 formatting possibilities compared to reStructuredText. `reStructuredText documentation <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_
0007
0008
0009 Local Build
0010 -----------
0011
0012
0013 Requirments:
0014 ~~~~~~~~~~~~
0015
0016
0017 - `Sphinx <http://www.sphinx-doc.org/en/master>`_ - Python documentation generator
0018 - `Read the Docs Sphinx Theme <https://sphinx-rtd-theme.readthedocs.io/en/stable/>`_ - Theme for final output
0019 - `recommonmark <https://github.com/miyakogi/m2r>`_ - Markdown to reStructuredText
0020
0021
0022 .. code: bash
0023
0024 pip install sphinx sphinx_rtd_theme recommonmark
0025
0026
0027 Building
0028 ~~~~~~~~
0029
0030 .. code: bash
0031
0032 pip install --upgrade sphinx-autobuild sphinx_rtd_theme recommonmark
0033
0034 # from project root
0035 sphinx-autobuild docs docs/_build/html
0036
0037 # from docs root
0038 sphinx-autobuild . _build/html
0039
0040
0041
0042 Read the docs
0043 ~~~~~~~~~~~~~
0044
0045 The documentation is available at https://g4e.readthedocs.io
0046
0047 It updates automatically when changes are pushed do the repo
0048
