Skip to content
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

Hide showing object as a base class; fix skipping documentation of forward; fixed docutils dependency. #643

Merged
merged 3 commits into from
Mar 2, 2022

Conversation

ravi-mosaicml
Copy link
Contributor

…`forward`; fixed docutils dependency.

* Fixed how we skip documenting `forward` so it will still show up for overriden subclasses
* Stopped showing base classes when the only base class is `object`. Closes #638
* Added docutils>=0.17 to setup.py. See https://myst-parser.readthedocs.io/en/latest/sphinx/use.html?highlight=parser#include-markdown-files-into-an-rst-file
@ravi-mosaicml
Copy link
Contributor Author

The readthedocs.com build is still showing bases: object but the local build isn't. @bandish-shah thoughts?
image

@bandish-shah
Copy link
Contributor

The readthedocs.com build is still showing bases: object but the local build isn't. @bandish-shah thoughts? image

Interesting, I ran the build locally on this branch and am still seeing bases: object show up:
image

@ravi-mosaicml
Copy link
Contributor Author

Fixed it; needed to add a :py: in front.

@ravi-mosaicml ravi-mosaicml merged commit ba47c80 into dev Mar 2, 2022
@ravi-mosaicml ravi-mosaicml deleted the ravi/i638 branch March 2, 2022 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs Nit: Hide the base class when the base is object
3 participants