search

TopoToolbox / pytopotoolbox

Python interface to TopoToolbox
https://topotoolbox.github.io/pytopotoolbox/
GNU General Public License v3.0
1 stars 2 forks source link

Set up Sphinx + autodoc #31

Closed wkearn closed 1 month ago

wkearn commented 2 months ago

@Teschl: do you want to try to get this working? Sphinx was pretty easy to get set up in libtopotoolbox: most of the complexity was in getting it to work with Doxygen for the auto-generated function reference. I think it is easiest to start by getting the docs to build locally then we can add a CI job (#27) to build and publish to GitHub pages.

Teschl commented 1 month ago

Generating the basic sphinx documentation for the python package is straight forward. Do we want the libtopotoolbox documentation and the pytopotoolbox documentation in the same sphinx html docs? I have not been able to combine them as of right now.

If they will be separate, I will go try to mirror your implementation as best I can. Then we can link between them.

wkearn commented 1 month ago

I think having them separated is the easiest thing for now.

There are some limitations to deploying each site separately: namely that linking between them and keeping everything synchronized becomes more complicated. If we feel after we've got some experience with it that it would be better to build everything in one place, we can do it in the TopoToolbox/topotoolbox.github.io repository.