Skip to content

Auto-build docs using sphinx

Duncan Macleod requested to merge duncanmmacleod/python-ligo-lw:docs into master

This merge adds a gitlab-ci configuration that uses sphinx to build documentation pages for this package. The docs are built on every commit, but only published for git tags. The docs will render here:

https://docs.ligo.org/kipp.cannon/python-ligo-lw/

The build should be fairly self-sufficient, requiring little maintenance, as long as the setup.py install_requires list is kept up-to-date relative to the actual library dependencies.

In order to have this build cleanly, the following library changes were made:

  • 36faf3f5: added missing dependencies to setup.py (except lalsuite)
  • 0336e9c2: corrected SyntaxError on python3
  • 1870e029: fixed usage of non-existent function
  • 2bb919cf: modified docstring to help sphinx formatting

Merge request reports