Joshuaalbert / jaxns

Probabilistic Programming and Nested sampling in JAX
https://jaxns.readthedocs.io/
Other
141 stars 9 forks source link

Documentation API Reference sidebar displays each item twice #77

Open alexlyttle opened 1 year ago

alexlyttle commented 1 year ago

Describe the bug During usage, I have noticed some issues with the documentation.

Minimal Verifiable Complete Example Go to https://jaxns.readthedocs.io/ and you will see the old warning message (image below). Then, click on "jaxns" under "API Reference" and scroll down. You will notice that items in the menu are duplicated.

Screenshots Screenshot 2023-01-04 at 09 36 19

Proposed fix Removing the warning message is easy, it can be deleted from docs/index.rst.

I am happy to investigate the menu issue as it's probably due to the automatic API generation conflicting with something.

JAXNS version 2.0