Edit this site! =============== `eic.phy.anl.gov/ip6/ `_ 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 `ATHENA SWG documentation GitLab repo `_ 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. .. code:: bash # 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) Development ----------- More formal explanation: Requirments: ^^^^^^^^^^^^ - `Sphinx `_ - Python documentation generator - `Read the Docs Sphinx Theme `_ - Theme for final output - `recommonmark `_ - Markdown pages support Sphinx Building ^^^^^^^^ .. code:: bash # 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 .. Commented out until readthedocs are there .. Read the docs .. ^^^^^^^^^^^^^^ .. The documentation is available at https://ip6soft.readthedocs.io .. It updates automatically when changes are pushed do the repo