search

sirocco-rt / sirocco

This is the repository for Sirocco, the radiative transfer code used to model winds in AGN and other systems
GNU General Public License v3.0
30 stars 24 forks source link

Add py_progs to sphinx documentation #1075

Closed smangham closed 6 months ago

smangham commented 6 months ago

We don't have most of the py_progs in the Sphinx documentation site - py_docs is supposed to handle documentation of them but we don't re-run it often. I'll add more of them. We should have a 'Additional scripts' category for the less interesting ones.

I experimented with sphinx-auto-api yesterday but it didn't seem to work well with our code so I'll neglect that for the moment and do it manually.

This should be a very short bit of work.

smangham commented 6 months ago

This is, of course, much more work than expected. For some reason it's now failing to build with a NotImplementedError: <class 'sphinx.writers.html5.HTML5Translator'> departing unknown node type: CodeAreaNode error, which appears to be down to the notebook import not working. However, it was working with the exact same package list bar h5py and sphinx-icon, so I'm removing sphinx-icon and seeing what happens.

smangham commented 6 months ago

Finally got it working, for some reason sphinx-icons broke it? Current build is here