cms-gem-daq-project / gem-plotting-tools

Repository for GEM commissioning plotting tools
GNU General Public License v3.0
1 stars 26 forks source link

Public documentation: ReadTheDocs (or other) integration #137

Closed lmoureaux closed 4 years ago

lmoureaux commented 6 years ago

Brief summary of issue

The documentation for the latest version should be built without human intervention.

Types of issue

Expected Behavior

The public documentation is automatically rebuilt every time develop is updated or a new version is tagged.

Current Behavior

The documentation has to be built manually, then copied to some public location such as http://homepage.iihe.ac.be/~lmoureau/GEM/sphinx/html/index.html.

Possible Solution

Integrate the repository with an automatic system such as ReadTheDocs. Some changes are needed because AFAIK we can't install PyROOT on the doc builder machine.

Context

The documentation has been migrated to Sphinx, but we can't really use it as long as it's not available on a public page. Updating it by hand is not a sustainable mode of operation.

jsturdy commented 6 years ago

We will be using EOS served websites served with a CERN service account that is used for various GEM DAQ related tasks. The easiest will probably be to do this via gitlab-ci as we'll have closer access to CERN resources there (this is also where the yum repository will be hosted)

The overall structure is not yet set up and is not quite finalized, but once it is, it will be integrated into the CI for the various packages

lpetre-ulb commented 4 years ago

Documentation is pushed to the GEM DAQ test website and is about to be pushed to main GEM DAQ website.