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

Upgrade to qiskit_sphinx_theme 1.12 #273

Merged
merged 2 commits into from
May 24, 2023

Conversation

Eric-Arellano
Copy link
Contributor

The 1.12 theme release is focused on stability, including CSS fixes. See https://github.com/Qiskit/qiskit_sphinx_theme/releases/tag/1.12.0rc1 for the changelog.

It allows us to de-duplicate custom_directives.py, versionutils.py, and _static/no_image.png.

This PR also:

  • Adds missing pyproject.toml entry for how to build this distribution. It is highly recommended that all Python projects have this.
  • Enables -j auto with Sphinx to have parallelism. This should result in a faster docs build.
  • Adds tox -e docs-clean, which is useful because Sphinx's autodoc sometimes has bad cache state.

@Eric-Arellano
Copy link
Contributor Author

I think CI might have broken on main? These test failures don't look related to my changes.

@woodsp-ibm
Copy link
Member

woodsp-ibm commented May 23, 2023

I'll investigate and sort it out - I notice the scheduled builds have been failing daily for the past 5 days. Done: #274

@@ -61,7 +61,8 @@ commands =
sphinx-build -W -T --keep-going -b gettext docs/ docs/_build/gettext {posargs}
sphinx-intl -c docs/conf.py update -p docs/_build/gettext -l en -d docs/locale

[pycodestyle]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unused

@coveralls
Copy link

Pull Request Test Coverage Report for Build 5071613254

  • 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 75.793%

Totals Coverage Status
Change from base Build 5064052399: 0.0%
Covered Lines: 645
Relevant Lines: 851

💛 - Coveralls

@woodsp-ibm woodsp-ibm added stable backport potential The bug might be minimal and/or import enough to be port to stable type: documentation Issues related to documentation automerge labels May 24, 2023
@mergify mergify bot merged commit 25a6546 into qiskit-community:main May 24, 2023
15 checks passed
mergify bot pushed a commit that referenced this pull request May 24, 2023
Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
(cherry picked from commit 25a6546)
@Eric-Arellano Eric-Arellano deleted the upgrade-to-theme-12 branch May 24, 2023 21:10
mergify bot added a commit that referenced this pull request May 24, 2023
Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
(cherry picked from commit 25a6546)

Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge stable backport potential The bug might be minimal and/or import enough to be port to stable type: documentation Issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants