Move methods into class pages for docs

qiskit-community / qiskit-nature

Qiskit Nature is an open-source, quantum computing, framework for solving quantum mechanical natural science problems.

https://qiskit-community.github.io/qiskit-nature/

Apache License 2.0

306 stars 207 forks source link

Move methods into class pages for docs #1264

Closed arnaucasau closed 1 year ago

arnaucasau commented 1 year ago

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 https://github.com/Qiskit-Extensions/qiskit-experiments/pull/1231

coveralls commented 1 year ago

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
Change from base Build 6339298718:	0.0%
Covered Lines:	8706
Relevant Lines:	10038

💛 - Coveralls

woodsp-ibm commented 1 year ago

I'll just reference the comment I made in qiskit-optimization for others that may see that since this is similar https://github.com/qiskit-community/qiskit-optimization/pull/563#issuecomment-1758229728

mrossinek commented 1 year ago

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 commented 1 year ago

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