artefactual / atom-docs

Access to Memory (AtoM) documentation
https://www.accesstomemory.org/docs
Creative Commons Attribution Share Alike 4.0 International
17 stars 26 forks source link

Showcasing the changes made to generate a PDF with Sphinx #251

Closed eviau-artefactual closed 6 months ago

eviau-artefactual commented 8 months ago

Here are the changes I need to make to be able to generate a PDF with Sphinx, using make latexpdf.

Mostly I create a toctree and I use the :glob:option with the * pattern to fetch all relevant docs.

This is meant as a showcase, feel welcome to close this PR, and also to make suggestions if you think this could be useful to merge into the docs.

E.g. I wouldn't merge adding the .venv to the conf.py file...

I used Sphinx version 7.2.6

eviau-artefactual commented 6 months ago

I was not planning on merging this, it was more to showcase the code. So closing this now.