-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Math docs are inconsistent and have broken links #3871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Also the format of the docstrings is wrong. I don't actually know how the |
Is this related to #3879 ? |
@fonnesbeck That mis-formatting is all over the docs. I conjecture that what happens is that somewhere in reading files sphinx goes off the rails and from then on it does this wrong. I have not been able to figure this out because:
I used to think it was getting confused because of the use of |
Mighr be the space before the colon, yes. I recall using that before. Maybe check on a site where things are working. |
I'm afraid it's not that in any simple way -- some places with the single space are formatted correctly, and some with the correct spacing are formatted wrong, and vice versa. I'm at a loss to know how to fix this. Probably need to work up from very small documents to see where it goes wrong. |
This was fixed in #5439. As a side note, on the colon spacing issue that I have seen mentioned in several other issues too, the colon should be both preceded and followed by a space. There was a bug in the old v3 theme that didn't render things correctly when doing things right, but removing the space wasn't really fixing things. It was only breaking numpydoc parsing and telling sphinx everything was the parameter name instead of being name followed by type info. As shown in #5459 things are rendered correctly and significantly better when using the v4 (working) theme and the spaces before and after the colon. |
Description of your problem
The docs for the math api have inconsistent or broken links. For invlogit links to method documentation but none of the rest do. Sigmoid seems to be missing its api docs entirely. The definition of abs links to nothing.
https://docs.pymc.io/api/math.html

Desired State
All math methods are documented and link to the full method documentation
The text was updated successfully, but these errors were encountered: