DIRACGrid / DIRACOS

Project for creating bundle of DIRAC dependencies.
GNU General Public License v3.0
2 stars 9 forks source link

Sphinx setup for building documentation #132

Closed andresailer closed 4 years ago

andresailer commented 4 years ago

This adds the sphinx configuration for RTD to build the documentation. Fixes the dirac os parts of #130

At the moment I created a folder in the base dir called docs_rtd, but it could also be a subfolder of docs. Let me know what you prefer.

I had to create an index.rst to get a toctree going, I couldn't just use the README.rst as the basefile. Also fixed one warning from sphinx and one typo

It looks like this: https://diracos.readthedocs.io/en/latest/index.html

chrisburr commented 4 years ago

I had to create an index.rst to get a toctree going, I couldn't just use the README.rst as the basefile.

We could remove the table of contents from the README and just link to readthedocs?

chaen commented 4 years ago

I would go with @chrisburr suggestion, and then that's good for me !

andresailer commented 4 years ago

Is this what you had in mind?

If there is no links on github Readme.rst, I can also just merge everything in one folder and move the rst files from docs to docs/source ?

chaen commented 4 years ago

even better :)

andresailer commented 4 years ago

moved the files to docs/source.

If this is merged I will change the git location in RTD to diracgrid, and then someone with permissions needs to install the webhook so it gets updated. I added @chaen and @petricm as maintainers to the diracos.readthedocs.io as well.

chaen commented 4 years ago

@petricm can you take care of the webhook please ?

petricm commented 4 years ago

I cannot do the webhook, don't have enough karma. @fstagni has to do it.

fstagni commented 4 years ago

I think I did.