IP6 Collaboration

Main documentation for the EIC@IP6 collaboration https://eic.phy.anl.gov/ip6

Documentation

To Build the documentation on your local machine:

Requirments:

• Sphinx - Python documentation generator
• Read the Docs Sphinx Theme - Theme for final output
• recommonmark - Markdown to reStructuredText

pip install sphinx sphinx_rtd_theme recommonmark sphinx-autobuild

Building

# from project root
sphinx-autobuild docs docs/_build/html

# from docs root
sphinx-autobuild . _build/html

Read the docs

The documentation is available at https://eic.phy.anl.gov/ip6

It updates automatically when changes are pushed do the repo