LLNL / SSAPy

A Python package allowing for fast and precise orbital modeling.
https://software.llnl.gov/SSAPy/
MIT License
36 stars 8 forks source link

Fix docs build and warnings #24

Closed igoumiri closed 2 months ago

igoumiri commented 2 months ago

I fixed a bunch of things related to building the docs.

  1. Make links to classes and functions work in the API reference
  2. Make [source] links to github work
  3. Fix warning about _static
  4. Fix warnings about \d and \l
  5. Fix sphinx-autobuild command in docs README
  6. Add missing module (simple) to API reference

It still doesn't always work on the first try. I think maybe the issue is that autosummary generates partial docs (modules) based on the automodapi template, but a second pass is needed for automodapi to generate the rest of the docs (api) and sphinx-build doesn't always detect that it needs to re-run. So there might need to be further improvements there.