sphinx

sphinx

Example Sphinx site using GitLab Pages: https://pages.gitlab.io/sphinx

Name Last Update
.gitlab-ci.yml Loading commit data...
Makefile Loading commit data...
README.md Loading commit data...
conf.py Loading commit data...
index.rst Loading commit data...

Build Status


Example sphinx documentation website using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.


Table of Contents generated with DocToc

GitLab CI

This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml:

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

Requirements

Building locally

To work locally with this project, you'll have to follow the steps below:

  1. Fork, clone or download this project
  2. Install Sphinx
  3. Generate the documentation: make

The generated HTML will be located in the location specified by conf.py, in this case _build/html.

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 namespace.gitlab.io, where namespace is your username or groupname. This can be done by navigating to your project's Settings.

Read more about user/group Pages and project Pages.

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.

Troubleshooting

No issues reported yet.


Forked from https://gitlab.com/Eothred/sphinx