search

slaclab / simulacrum

Simulacrum is a system for simulating the LCLS accelerator and its control system.
Other
4 stars 20 forks source link

Basic mkdocs documentation #73

Closed ChristopherMayes closed 4 years ago

ChristopherMayes commented 4 years ago

I added basic docs, which mkdocs can use to generate static HTML on the gh-pages branch.

GitHub Pages needs to be activated in settings.

mkdocs is installed via:

conda install mkdocs pygments mkdocs-material
pip install

and then in the simulacrum root directory, run:

mkdocs gh-deploy