Skip to content

Update rtd-theme to the latest version #9316

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

Merged
zwoop merged 1 commit into from
Jan 18, 2023
Merged

Update rtd-theme to the latest version #9316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 2 deletions doc/Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ verify_ssl = true

[packages]

sphinx = ">=6.x"
# We pin Sphinx because the sphinx-rtd-theme suggests this as a best practice.
# If not, we will often face issues when Sphinx updates their version before
# sphinx-rtd-theme has had time to update their component for the new sphinx
# version.
sphinx = "==6.1.3"

sphinx-rtd-theme = "*"
sphinx-rtd-theme = ">=1.*"
sphinxcontrib-jquery = "*"
sphinxcontrib-plantuml = "*"
# i18n
Expand Down
22 changes: 6 additions & 16 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,14 @@
sys.path.insert(0, os.path.abspath('ext'))
sys.path.insert(0, os.path.abspath('.'))


# Allow for us to add our override CSS file (new with Sphinx 1.x)
def setup(app):
app.add_css_file('override.css')

# -- General configuration -----------------------------------------------------


# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
Expand Down Expand Up @@ -281,22 +287,6 @@ def issue_reference(self, match, lineno):
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['static']

# Include a stylesheet that overrides default table styling, to provide
# content wrapping.
html_context = {
'css_files': [
'_static/override.css'
]
}
if os.environ.get('READTHEDOCS', None) == 'True':
html_context = {
'css_files': [
'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
'_static/override.css'
]
}

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
Expand Down