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
Sphinx API documentation missing __magic__ methods #2502
Comments
Hmm, we have this in
Might be down to the version of Sphinx... |
Looking at the most recent master build, Tox installed:
And to be clear, it said:
Looking back, even https://biopython.org/docs/1.74/api/Bio.SeqRecord.html had this problem - perhaps the configuration used only worked with a specific 1.8.0b1 era version of Sphinx. |
It looks like the variable name was changed to be |
That is simple but subtle - I'm glad someone spotted it. Thank you! |
Here's where I suppose the other form |
Confirming the fix worked, https://biopython.org/docs/dev/api/Bio.Seq.html etc look good. Thank you @chebizarro 👍 |
e.g. https://biopython.org/docs/dev/api/Bio.Seq.html and https://biopython.org/docs/1.76/api/Bio.SeqRecord.html are missing the
__getitem__
documentation which describes slicing etc.Compare with https://biopython.org/DIST/docs/api/Bio.Seq.Seq-class.html (generated with epydoc, which we intend to drop.
This is likely down to a miss-configuration in https://github.com/biopython/biopython/blob/master/Doc/api/conf.py
To build the documentation locally (see also #1803), use:
The text was updated successfully, but these errors were encountered: