Example sphinx documentation website using GitLab Pages.
Table of Contents generated with DocToc
- GitLab CI
- Building locally
- GitLab User or Group Pages
- Did you fork this project?
image: alpine pages: script: - apk --no-cache add py2-pip python-dev - pip install sphinx - apk --no-cache add make - make html - mv _build/html/ public/ artifacts: paths: - public only: - master
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Install Sphinx
- Generate the documentation:
The generated HTML will be located in the location specified by
in this case
GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to
groupname. This can be done by navigating to your
Did you fork this project?
If you forked this project for your own use, please go to your project's Settings and remove the forking relationship, which won't be necessary unless you want to contribute back to the upstream project.
No issues reported yet.
Forked from https://gitlab.com/Eothred/sphinx