Skip to content

Commit

Permalink
Sync to newest Furo version (#559)
Browse files Browse the repository at this point in the history
Closes #557. See the
process:


https://github.com/Qiskit/qiskit_sphinx_theme/blob/551c223324ba03f9e3a321b458722cd4244941bf/CONTRIBUTING.md?plain=1#L180-L183

This also improves our project metadata so that our Readme will now be
included on the PyPI page.
  • Loading branch information
Eric-Arellano authored Aug 23, 2023
1 parent 551c223 commit d1a353d
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 13 deletions.
9 changes: 4 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ build-backend = "sphinx_theme_builder"
[project]
name = "qiskit-sphinx-theme"
description = "A Sphinx theme for Qiskit and Qiskit Ecosystem projects"
readme = "README.md"
dynamic = ["version"]

license = { file = "LICENSE" }
Expand All @@ -24,14 +25,12 @@ classifiers = [

dependencies = [
"docutils",
# Keep in sync with Furo's constraint. <7.2 is to work
# around https://github.com/sphinx-doc/sphinx/issues/11608
# and https://github.com/pradyunsg/furo/discussions/693.
"sphinx>=6.0,<7.2",
# Keep in sync with Furo's constraint.
"sphinx>=6.0",
# Remove jQuery once we get rid of the Pytorch theme.
"sphinxcontrib-jquery",
# See CONTRIBUTING.md for how to upgrade Furo.
"furo==2023.5.20",
"furo==2023.8.19",
]

[project.entry-points."sphinx.html_themes"]
Expand Down
4 changes: 2 additions & 2 deletions src/qiskit_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ def remove_thebe_if_not_needed(
"https://unpkg.com/thebelab@latest/lib/index.js",
]
context["script_files"] = [
js_file for js_file in context["script_files"] if js_file not in thebe_js_files
js_file for js_file in context["script_files"] if js_file.filename not in thebe_js_files
]

thebe_css_files = ["_static/thebelab.css", "_static/sphinx-thebe.css"]
context["css_files"] = [
css_file for css_file in context["css_files"] if css_file not in thebe_css_files
css_file for css_file in context["css_files"] if css_file.filename not in thebe_css_files
]


Expand Down
6 changes: 0 additions & 6 deletions src/qiskit_sphinx_theme/assets/styles/_layout.scss
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,3 @@ $right-sidebar-width: 15em; // Default in Furo.
flex: 0 0 $right-sidebar-width;
min-width: $right-sidebar-width;
}

// Remove once https://github.com/pradyunsg/furo/commit/c8b51d09af3dcaac3046f7e761119e9d1b7c9e37
// is released.
article {
overflow-wrap: break-word;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d1a353d

Please sign in to comment.