search

qiskit-community / qiskit-metal

Quantum Hardware Design. Open-source project for engineers and scientists to design superconducting quantum devices with ease.
https://qiskit-community.github.io/qiskit-metal/
Apache License 2.0
270 stars 201 forks source link

Move methods into class pages for docs #976

Closed arnaucasau closed 7 months ago

arnaucasau commented 8 months ago

Summary

Moved all the methods and attributes into class pages to speed up the building process of the documentation with the new ecosystem sphinx theme in https://github.com/qiskit-community/qiskit-metal/pull/975. The new theme increases the time building the documentation when we have a lot of pages, and with this PR we can achieve a major speedup.

See https://github.com/Qiskit/qiskit/pull/10455 for more information.

zlatko-minev commented 8 months ago

Great, call, thank you. Will take a look at the linting soon

arnaucasau commented 8 months ago

Running tox -e docs locally it compiles and does what we expect, but it seems like it adds some extra warning to the ones that we can find in the main branch. I can fix them, but I was thinking of waiting until the CI in the main branch is fix to avoid mixing the warnings.

arnaucasau commented 7 months ago

Yes :) With this PR merged we will be able to see a speed up building the documentation using the new theme in #975

arnaucasau commented 7 months ago

@zlatko-minev I don't have write access to merge it. Can you do it when you have a moment, please? Thank you!!