Update this documentation

  • This site is built automatically using github actions on every push.

  • The deployed version reflects the main branch

  • It is also possible to build locally using: make html

Workflow

1. Clone the repository

git clone git@github.com:epoc-ed/manual.git

2. Make a new branch

git branch some_feature
git checkout some_feature

3. Make your changes

4. Push the new branch to github

git push --set-upstream origin some_feature

5. Inspect your changes

  • Under the Actions tab you can see the build status of your branch

  • If the build is successful, you can download the html files from the artifacts tab

6. Make PR to merge your changes to the main branch

Local build

Note

You only need to create the environment once. After that you can activate it and build the documentation.

#install the dependencies listed in etc/environment.yml
conda env create -f etc/environment.yml

#activate the environment
conda activate docs

#build the documentation
make html