-
Benjamin Setterholm authored
To build local documentation, make sure you have sphinx installed: conda install sphinx conda install sphinx_rtd_theme Next, `cd` into the `doc` directory and run `make html`. Open `doc/build/index.html` to read the documentation. Note that it is possible to auto-regenerate this webpage with each commit to master, and allow it to be hosted as a website on GitLab. To get this to work, the administrator has to configure GitLab Pages on the workspace (see https://docs.gitlab.com/ee/administration/pages/ for details) and we need to set up GitLab CI for this repository and post a file with the name `.gitlab-cl.yml` in the top level of the project with contents: ~~~yml image: python:3.7-alpine test: stage: test script: - pip install -U sphinx - sphinx-build -b html doc/source public only: - branches except: - master pages: stage: deploy script: - pip install -U sphinx - sphinx-build -b html doc/source public artifacts: paths: - public only: - master ~~~
Benjamin Setterholm authoredTo build local documentation, make sure you have sphinx installed: conda install sphinx conda install sphinx_rtd_theme Next, `cd` into the `doc` directory and run `make html`. Open `doc/build/index.html` to read the documentation. Note that it is possible to auto-regenerate this webpage with each commit to master, and allow it to be hosted as a website on GitLab. To get this to work, the administrator has to configure GitLab Pages on the workspace (see https://docs.gitlab.com/ee/administration/pages/ for details) and we need to set up GitLab CI for this repository and post a file with the name `.gitlab-cl.yml` in the top level of the project with contents: ~~~yml image: python:3.7-alpine test: stage: test script: - pip install -U sphinx - sphinx-build -b html doc/source public only: - branches except: - master pages: stage: deploy script: - pip install -U sphinx - sphinx-build -b html doc/source public artifacts: paths: - public only: - master ~~~
Loading