[feature] Unified docs building for legacy code - Githubissues

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

[feature] Unified docs building for legacy code #294

Closed jsturdy closed 4 years ago

jsturdy commented 4 years ago

Description

Uniform building of docs for legacy code:

on demand creation of conda environment for python deps (if specified)
- USE_CONDA can be set at docs building time to flag these behaviours
- if USE_CONDA is not set, the environment from which make doc is called needs all dependencies installed
split source and build directories for sphinx
use sphinx-autoapi for python docs automation
- no need for manually creating the autodoc stubs

Types of changes

[x] New feature (non-breaking change which adds functionality)

Motivation and Context

Requests for documentation of legacy code

How Has This Been Tested?

https://test-gemdaq-ci.web.cern.ch/test-gemdaq-ci/docs/api/vfatqc/latest/

jsturdy commented 4 years ago

last changes I think have been pushed.
docs site updated
docstrings could be cleaned up in the python code, because there are various warnings/errors in the building, but they don't really prevent the docs from rendering, they would simply be made nicer