Skip to content

add sphinx docs build directory

Johan Bregeon requested to merge add_sphinx_doc into main

I have just added the basic element to be able to build the sphinx documentation of our code.

  • The main thing is the new docs directory.
  • I have also fix some doc alignment in SoftwareManager.py for sphinx to be happy.
  • I have added sphinx_rtd_theme dependency in the setup.cfg (that is the ReadTheDocs style theme)

I have done that in the simplest way, as looking into the https://github.com/DIRACGrid/DIRAC/tree/integration/docs directory, things look too complicated for me.

Just install this branch, e.g.:

curl -LO https://github.com/DIRACGrid/DIRACOS2/releases/latest/download/DIRACOS-Linux-x86_64.sh
bash DIRACOS-Linux-x86_64.sh
source diracos/diracosrc
git clone git@gitlab.cta-observatory.org:cta-computing/dpps/CTADIRAC.git
cd CTADIRAC
git checkout add_sphinx_doc
git branch
pip install -e .

and then:

cd docs
make html

open in a browser _build/html/index.html

There is then much to be done, to document the whole code properly.

Merge request reports