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 #976

Merged
merged 2 commits into from
Nov 9, 2023

Conversation

arnaucasau
Copy link
Contributor

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 #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 Qiskit/qiskit#10455 for more information.

@zlatko-minev
Copy link
Collaborator

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

@zlatko-minev zlatko-minev self-requested a review October 20, 2023 17:00
Copy link
Collaborator

@zlatko-minev zlatko-minev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compiles ok on your end?

@arnaucasau
Copy link
Contributor Author

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 arnaucasau mentioned this pull request Oct 20, 2023
Copy link
Collaborator

@zlatko-minev zlatko-minev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, this can be merged now, what do you think?

@arnaucasau
Copy link
Contributor Author

arnaucasau commented Nov 9, 2023

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

@arnaucasau
Copy link
Contributor Author

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

@zlatko-minev zlatko-minev merged commit d4e9c1e into qiskit-community:main Nov 9, 2023
8 checks passed
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.

2 participants