Edit this site!
This site is open to everyone. Users are encouraged to contribute to this documentation! If you would like to add/edit the information on this site - you are welcome to do this!
The pages are automatically updated, when changes are commited to the master branch of
P.S. The suggested update workflow is by creating merge requests
Running on your machine
For more extensive editing it is convenient to run the site on your local machine to instantly see the changes.
# get the website git pull https://eicweb.phy.anl.gov/EIC/documentation/athena athena_doc # install sphinx python libraries python3 -m pip install sphinx sphinx_rtd_theme recommonmark sphinx-autobuild # start the site cd athena_doc sphinx-autobuild docs docs/_build/html
By default the site will be available at http://127.0.0.1:8000/ (you can look at sphinx-autobuild flags to change that)
More formal explanation:
# from project root sphinx-autobuild docs docs/_build/html # from docs root sphinx-autobuild . _build/html # one time build without watching for changes sphinx-build docs docs/_build/html