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

Move methods into class pages for docs #1264

Merged
merged 6 commits into from
Oct 13, 2023

Conversation

arnaucasau
Copy link
Contributor

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

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
@arnaucasau arnaucasau changed the title Move methods into class pages for docs WIP - Move methods into class pages for docs Oct 9, 2023
@arnaucasau arnaucasau changed the title WIP - Move methods into class pages for docs Move methods into class pages for docs Oct 10, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6473927923

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 86.73%

Totals Coverage Status
Change from base Build 6339298718: 0.0%
Covered Lines: 8706
Relevant Lines: 10038

💛 - Coveralls

@arnaucasau arnaucasau marked this pull request as ready for review October 11, 2023 11:16
@woodsp-ibm
Copy link
Member

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)

@mrossinek
Copy link
Member

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 ?

@arnaucasau
Copy link
Contributor Author

arnaucasau commented Oct 12, 2023

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):

Version in #1262:
604.91s (sphinx-build)
251 KB index.html size
39 MB total size

Moving the docs into class pages:
76.16s (sphinx-build)
65 KB index.html size
14.9 MB total size

Copy link
Member

@mrossinek mrossinek left a 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! 👍

@mrossinek mrossinek merged commit 7de5334 into qiskit-community:main Oct 13, 2023
@mrossinek mrossinek mentioned this pull request Oct 13, 2023
ialsina pushed a commit to ialsina/qiskit-nature that referenced this pull request Nov 17, 2023
* 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>
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.

4 participants