search

ilikecubesnstuff / commensurability

Packages for calculating orbit commensurabilities.
https://commensurability.readthedocs.io/en/latest/
MIT License
2 stars 2 forks source link

Test the docs as part of CI #19

Open nstarman opened 3 months ago

nstarman commented 3 months ago

Coming from #18, it would be great to test the docs as part of CI. I recommend https://sybil.readthedocs.io/en/latest/, it's easy to use and very configurable. I'm happy to push a PR.

— openjournals/joss-reviews#7009

ilikecubesnstuff commented 1 day ago

Thank you for the suggestion, this is certainly a good idea. There are a few concerns I have regarding using Sybil:

  1. Is the markdown parser configurable for files such as mw_orbit.md? In the documentation, this formatting displays multiple tabs above each code block.
  2. Many of the documentation scripts depend on packages like agama or galpy, sometimes specific versions; I am unsure how to extract scripts particular to a certain package with Sybil. Ideally, all the scripts associated with one package happen in one testing environment, but configuring this into CI is unclear to me.

Pushing a PR would be greatly appreciated, please let me know if that can be arranged!