-
Notifications
You must be signed in to change notification settings - Fork 208
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
Move methods into class pages for docs #1264
Conversation
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Pull Request Test Coverage Report for Build 6473927923
💛 - Coveralls |
I'll just reference the comment I made in qiskit-optimization for others that may see that since this is similar qiskit-community/qiskit-optimization#563 (comment) |
How does this impact the build time of the docs in the new theme? I.e. how will this change the times (and build sizes) reported in #1262 ? |
In this project, the speed up is noticeable. I have run locally the sphinx-build command with the version in #1262 and then adding the changes in this PR, and here are the results (time and size):
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for looking into this! 👍
* Move methods into class pages for docs Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> * :no-index: removed * fix the templates * modifying the templates and lint test * adding conditions old templates * Update class_no_inherited_members.rst --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Summary
Moved the methods into class pages to speed up the building process of the documentation with the new ecosystem sphinx theme (PR) following the steps made in qiskit-community/qiskit-experiments#1231