Skip to content

Readthedocs (theme) for documentation?

Pieter David requested to merge piedavid/bamboo:doc_rtd into master

The readthedocs theme is quite nice, especially for reference documentation, so I decided to give it a try... preview output at https://bamboo-hep.readthedocs.io/en/latest/ . WIP because I should adjust the path and remove the documentation build and upload from the CI if we decide to switch.

There are three options:

  • keep things as they are
  • use the readthedocs theme, but build in gitlab CI and host on the CP3 webserver
  • use readthedocs to build and host the documentation. All links can be kept working with a redirect (I set that up at https://cp3.irmp.ucl.ac.be/~pdavid/bamboo_rtd/ to check)

Opinions/preferences?

Edited by Pieter David

Merge request reports