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

Switch to Furo docs theme #10498

Closed
wants to merge 7 commits into from
Closed

Conversation

Eric-Arellano
Copy link
Collaborator

@Eric-Arellano Eric-Arellano commented Jul 25, 2023

This switches to qiskit-sphinx-theme's Furo-based theme, which is based on pip docs. It makes our docs Carbon compliant and much more useful, including the left sidebar now including the whole page ToC for more functional navigation.

Furo is naively slower (Qiskit/qiskit_sphinx_theme#328): the docs build wall-time goes from 13.75 minutes to 40 minutes. So, we distinguish between prod builds (which will be added in Qiskit/qiskit-metapackage#1779) vs. dev/CI builds. CI builds only take 15 minutes, a 1.25 minute slowdown. The slowdown comes from viewcode (14 minutes) and including the API docs in the left sidebar (11 minutes).

@coveralls
Copy link

coveralls commented Jul 25, 2023

Pull Request Test Coverage Report for Build 5669101634

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 5 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.002%) to 85.907%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 2 90.89%
qiskit/pulse/library/waveform.py 3 93.75%
Totals Coverage Status
Change from base Build 5667924881: 0.002%
Covered Lines: 73026
Relevant Lines: 85006

💛 - Coveralls

@Eric-Arellano Eric-Arellano changed the title [experiment] Switch to Furo docs theme Switch to Furo docs theme Jul 26, 2023
mtreinish pushed a commit to Qiskit/qiskit-metapackage that referenced this pull request Jul 28, 2023
See Qiskit/qiskit#10498 for the
motivation.

Note that in Terra, we distinguish between dev/CI builds vs. prod
builds. We don't make that distinguishment here because we don't get
much dev activity in this repo.
jakelishman pushed a commit to jakelishman/qiskit-terra that referenced this pull request Aug 11, 2023
See Qiskit#10498 for the
motivation.

Note that in Terra, we distinguish between dev/CI builds vs. prod
builds. We don't make that distinguishment here because we don't get
much dev activity in this repo.
@jakelishman
Copy link
Member

I believe that #10611 obsoleted this, but it's worth checking.

@Eric-Arellano
Copy link
Collaborator Author

I believe that #10611 obsoleted this, but it's worth checking.

Not quite. This PR distinguished between dev/CI vs prod builds and had some optimizations to speed up dev builds. I will open a dedicated PR for that.

@Eric-Arellano Eric-Arellano deleted the furo branch August 14, 2023 18:14
SamD-1998 pushed a commit to SamD-1998/qiskit-terra that referenced this pull request Sep 7, 2023
See Qiskit#10498 for the
motivation.

Note that in Terra, we distinguish between dev/CI builds vs. prod
builds. We don't make that distinguishment here because we don't get
much dev activity in this repo.
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.

3 participants