upstream/borgbackup
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-06-09 17:00:11 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Merge pull request #8739 from ThomasWaldmann/update2-rtd-master

Browse source 
docs: add sphinxcontrib.jquery
This commit is contained in:
TW 2025-04-10 20:10:21 +02:00 committed by GitHub
commit 0eef4abd59
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/conf.py
View file

@ -104,15 +104,13 @@ import guzzle_sphinx_theme
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = "guzzle_sphinx_theme"
# Register the theme as an extension to generate a sitemap.xml
extensions.append("guzzle_sphinx_theme")
def set_rst_settings(app):
app.env.settings.update({"field_name_limit": 0, "option_limit": 0})
def setup(app):
app.setup_extension("sphinxcontrib.jquery")
app.add_css_file("css/borg.css")
app.connect("builder-inited", set_rst_settings)
@ -246,6 +244,8 @@ extensions = [
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.viewcode",
"sphinxcontrib.jquery", # jquery is not included anymore by default
"guzzle_sphinx_theme", # register the theme as an extension to generate a sitemap.xml
]
extlinks = {

1
requirements.d/docs.txt
View file

@ -1,2 +1,3 @@
sphinx
sphinxcontrib-jquery
guzzle_sphinx_theme

1
tox.ini
View file

@ -48,6 +48,7 @@ commands = mypy --ignore-missing-imports
changedir = docs
deps =
sphinx
sphinxcontrib-jquery
guzzle_sphinx_theme
commands =
sphinx-build -n -v -W --keep-going -b html -d {envtmpdir}/doctrees . {envtmpdir}/html