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.

Sign up for GitHub

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

Docs: Fix sphinx and theme upgrade #2736

Merged
merged 6 commits into from
May 26, 2024
Merged

Docs: Fix sphinx and theme upgrade #2736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dcc4de7
Remove unnecessary python
plaindocs May 26, 2024
5e9edba
Downgrade docutils to officially supported
plaindocs May 26, 2024
a7e34f5
Restore theme name
plaindocs May 26, 2024
20a8265
Fix ruff error
plaindocs May 26, 2024
088105c
Rename css options
plaindocs May 26, 2024
3717867
Conform to style
plaindocs May 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
import os
import subprocess

import sphinx_rtd_theme


# Run command `locust --help` and store output in cli-help-output.txt which is included in the docs
def save_locust_help_output():
Expand Down Expand Up @@ -146,14 +144,10 @@ def save_locust_env_variables():
html_show_sourcelink = False
html_file_suffix = ".html"
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]


# Custom CSS overrides
html_static_path = ["_static"]
html_context = {
"css_files": ["_static/theme-overrides.css", "_static/css/rtd_sphinx_search.min.css"],
}
html_css_files = ["_static/theme-overrides.css", "_static/css/rtd_sphinx_search.min.css"]


# HTML theme
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Sphinx-Substitution-Extensions==2020.9.30.0
Pygments==2.16.1
alabaster==0.7.16
babel==2.13.0
docutils==0.20.1
docutils==0.18.1
imagesize==1.4.1
snowballstemmer==2.2.0
sphinx-prompt==1.5.0
Expand Down
Loading