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

[experiment] Add remove_methods_from_toc option to speed up docs #474

Closed
wants to merge 1 commit into from

Conversation

Eric-Arellano
Copy link
Collaborator

An attempt to work around #328 by pre-processing the table of contents before Furo gets to it by removing all pages that look like methods. We're limited in the logic to only being able to look at page names and can't e.g. determine level of nesting.

This is an alternative to setting the navigation_depth (pradyunsg/furo#674 and #451).

The better approach is for projects to get rid of the methods pages entirely, but this gives a workaround.

@Eric-Arellano
Copy link
Collaborator Author

This resulted in a Terra docs build of 1.5 hours rather than 3.5 hours. A big improvement, but still too slow.

Instead, we'll pursue two approaches:

  1. Switch Terra to not have methods pages
  2. Probably land navigation_depth option for qiskit-sphinx-theme. Even if we don't set it in prod, it will make local development faster.

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.

1 participant