Commit Graph

46 Commits

Author SHA1 Message Date
dependabot[bot]
436b6e1793 Bump sphinx-rtd-theme from 3.0.1 to 3.0.2
Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 3.0.1 to 3.0.2.
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/3.0.1...3.0.2)

---
updated-dependencies:
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-11-14 09:05:48 +00:00
dependabot[bot]
49de9cf63c Bump sphinxcontrib-video from 0.2.1 to 0.3.1
Bumps [sphinxcontrib-video](https://github.com/sphinx-contrib/video) from 0.2.1 to 0.3.1.
- [Release notes](https://github.com/sphinx-contrib/video/releases)
- [Commits](https://github.com/sphinx-contrib/video/compare/v0.2.1...v0.3.1)

---
updated-dependencies:
- dependency-name: sphinxcontrib-video
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-11-11 09:29:03 +00:00
Hana - Piralein
6a9dc9b6a9 Update Sphinx version 2024-11-01 08:26:58 +01:00
Hugo Locurcio
3e3bbde35b Add support for embedding videos in documentation pages
This is more efficient than GIFs, animated PNGs or WebPs, while also
providing controls and audio playback if needed.
2024-03-27 19:58:27 +01:00
Max Hilbrunner
f7e0df5783 Pin more sphinx-contrib packages 2024-01-13 16:41:42 +01:00
Max Hilbrunner
e34678fbc3 Pin more sphinx-contrib packages 2024-01-13 16:03:55 +01:00
Max Hilbrunner
8e8147d3f2 Pin sphinxcontrib-applehelp, fix RTD Sphinx build 2024-01-13 15:45:33 +01:00
bitsawer
b3db4c16b4 Update pygments to 2.15.1 and restore fixed shader syntax highlighting 2023-05-29 17:53:09 +03:00
Justin McGettigan
2f919ba970 Add the 'sphinx-copybutton' Sphinx extension. (#6918)
* Added the 'sphinx-copybutton' Sphinx extension.
2023-04-17 18:32:15 +02:00
Yuri Sizov
64a60696bf Pin additional build requirements to avoid syntax highlighting issues 2023-01-14 18:49:07 +03:00
Max Hilbrunner
f79f748f55 Revert to sphinx-tabs 3.4.0
Revert sphinx-tabs back to 3.4.0 to fix dependency conflict. 
The conflict is caused by:
- sphinx 4.4.0 depends on docutils<0.18 and >=0.14
- sphinx-rtd-theme 1.1.1 depends on docutils<0.18
- sphinx-tabs 3.4.1 depends on docutils~=0.18.0
2023-01-09 23:59:11 +01:00
Max Hilbrunner
20f33d0b13 Merge pull request #5910 from godotengine/dependabot/pip/sphinx-tabs-3.4.1
Bump sphinx-tabs from 3.3.1 to 3.4.1
2023-01-09 23:05:44 +01:00
Max Hilbrunner
6414fe31f4 Merge pull request #6556 from godotengine/dependabot/pip/sphinxext-opengraph-0.7.5
Bump sphinxext-opengraph from 0.6.3 to 0.7.5
2023-01-09 23:05:29 +01:00
dependabot[bot]
734d0b3503 Bump sphinxext-opengraph from 0.6.3 to 0.7.5
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.6.3 to 0.7.5.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.3...v0.7.5)

---
updated-dependencies:
- dependency-name: sphinxext-opengraph
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-01-04 09:01:15 +00:00
dependabot[bot]
aba6709e71 Bump sphinx-rtd-theme from 1.0.0 to 1.1.1
Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 1.0.0 to 1.1.1.
- [Release notes](https://github.com/readthedocs/sphinx_rtd_theme/releases)
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/1.0.0...1.1.1)

---
updated-dependencies:
- dependency-name: sphinx-rtd-theme
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-11-08 09:02:06 +00:00
dependabot[bot]
3b2bf0cf35 Bump sphinx-tabs from 3.3.1 to 3.4.1
Bumps [sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) from 3.3.1 to 3.4.1.
- [Release notes](https://github.com/executablebooks/sphinx-tabs/releases)
- [Changelog](https://github.com/executablebooks/sphinx-tabs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/executablebooks/sphinx-tabs/compare/v3.3.1...v3.4.1)

---
updated-dependencies:
- dependency-name: sphinx-tabs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-07-19 15:05:58 +00:00
dependabot[bot]
a4a1d90c80 Bump sphinx-notfound-page from 0.8 to 0.8.3
Bumps [sphinx-notfound-page](https://github.com/readthedocs/sphinx-notfound-page) from 0.8 to 0.8.3.
- [Release notes](https://github.com/readthedocs/sphinx-notfound-page/releases)
- [Changelog](https://github.com/readthedocs/sphinx-notfound-page/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/readthedocs/sphinx-notfound-page/compare/0.8...0.8.3)

---
updated-dependencies:
- dependency-name: sphinx-notfound-page
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-07-14 09:08:26 +00:00
dependabot[bot]
88e9253fd0 Bump sphinxext-opengraph from 0.6.2 to 0.6.3
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.6.2 to 0.6.3.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.2...v0.6.3)

---
updated-dependencies:
- dependency-name: sphinxext-opengraph
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-30 09:07:08 +00:00
dependabot[bot]
abee14c092 Bump sphinx-tabs from 3.3.0 to 3.3.1
Bumps [sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) from 3.3.0 to 3.3.1.
- [Release notes](https://github.com/executablebooks/sphinx-tabs/releases)
- [Changelog](https://github.com/executablebooks/sphinx-tabs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/executablebooks/sphinx-tabs/compare/v3.3.0...v3.3.1)

---
updated-dependencies:
- dependency-name: sphinx-tabs
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-18 09:08:55 +00:00
dependabot[bot]
664f6a1cbd Bump sphinx-tabs from 3.2.0 to 3.3.0 (#5672)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2022-03-10 16:54:46 +01:00
dependabot[bot]
3efce81adb Bump sphinxext-opengraph from 0.6.1 to 0.6.2
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.6.1 to 0.6.2.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.6.1...v0.6.2)

---
updated-dependencies:
- dependency-name: sphinxext-opengraph
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-09 09:07:15 +00:00
Rémi Verschelde
0123b98f1c requirements: Update to Sphinx 4.4.0, RTD theme 1.0.0, notfound 0.8
Needed to support Python 3.10.
2022-02-24 14:47:16 +01:00
dependabot[bot]
f990d624fb Bump sphinxext-opengraph from 0.5.1 to 0.6.1
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.5.1 to 0.6.1.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.5.1...v0.6.1)

---
updated-dependencies:
- dependency-name: sphinxext-opengraph
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-02-24 09:04:39 +00:00
dependabot[bot]
17bcff412a Bump sphinxext-opengraph from 0.5.0 to 0.5.1
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.5.0 to 0.5.1.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.5.0...v0.5.1)

---
updated-dependencies:
- dependency-name: sphinxext-opengraph
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-12-13 09:05:37 +00:00
dependabot[bot]
87c8f73767 Bump sphinxext-opengraph from 0.4.2 to 0.5.0 (#5405)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-11-22 16:22:57 +01:00
Max Hilbrunner
308f6e4f54 Pin docutils to <0.18 to fix CI due to new warning 2021-11-02 01:27:25 +01:00
dependabot[bot]
edc6472797 Bump sphinx-tabs from 3.1.0 to 3.2.0
Bumps [sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) from 3.1.0 to 3.2.0.
- [Release notes](https://github.com/executablebooks/sphinx-tabs/releases)
- [Changelog](https://github.com/executablebooks/sphinx-tabs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/executablebooks/sphinx-tabs/compare/v3.1.0...v3.2.0)

---
updated-dependencies:
- dependency-name: sphinx-tabs
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-08-05 09:04:18 +00:00
Yuri Sizov
dbea7fb4ad Update Sphinx to 4.0.2 to match RTD (#5140) 2021-08-01 16:19:48 +02:00
Max Hilbrunner
5a3954c465 Remove update block from sphinx-tabs extension
Now fine thanks to Calinou's Algolia work, yay (see https://github.com/godotengine/godot-docs/pull/4884)
2021-07-06 07:59:21 +02:00
dependabot[bot]
564a5067ad Bump sphinx-tabs from 1.3.0 to 3.1.0
Bumps [sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) from 1.3.0 to 3.1.0.
- [Release notes](https://github.com/executablebooks/sphinx-tabs/releases)
- [Changelog](https://github.com/executablebooks/sphinx-tabs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/executablebooks/sphinx-tabs/compare/v1.3.0...v3.1.0)

---
updated-dependencies:
- dependency-name: sphinx-tabs
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-14 07:15:37 +00:00
Leroy Bakker
6ae96e7b50 Implemented Algolia search (#4884)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-06-13 20:21:11 +02:00
dependabot[bot]
df6f0df57b Bump sphinxext-opengraph from 0.4.1 to 0.4.2 (#4938)
Bumps [sphinxext-opengraph](https://github.com/wpilibsuite/sphinxext-opengraph) from 0.4.1 to 0.4.2.
- [Release notes](https://github.com/wpilibsuite/sphinxext-opengraph/releases)
- [Commits](https://github.com/wpilibsuite/sphinxext-opengraph/compare/v0.4.1...v0.4.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-27 08:11:49 +02:00
dependabot[bot]
7f2a3e8b55 Bump sphinx-notfound-page from 0.6 to 0.7.1
Bumps [sphinx-notfound-page](https://github.com/readthedocs/sphinx-notfound-page) from 0.6 to 0.7.1.
- [Release notes](https://github.com/readthedocs/sphinx-notfound-page/releases)
- [Changelog](https://github.com/readthedocs/sphinx-notfound-page/blob/0.7.1/CHANGELOG.rst)
- [Commits](https://github.com/readthedocs/sphinx-notfound-page/compare/0.6...0.7.1)

Signed-off-by: dependabot[bot] <support@github.com>
2021-05-21 06:06:33 +00:00
dependabot[bot]
9940fc39b3 Bump sphinx-rtd-theme from 0.5.1 to 0.5.2
Bumps [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) from 0.5.1 to 0.5.2.
- [Release notes](https://github.com/readthedocs/sphinx_rtd_theme/releases)
- [Changelog](https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/changelog.rst)
- [Commits](https://github.com/readthedocs/sphinx_rtd_theme/compare/0.5.1...0.5.2)

Signed-off-by: dependabot[bot] <support@github.com>
2021-04-06 06:40:48 +00:00
Hugo Locurcio
a912322c60 Pin sphinx-tabs to 1.3.0 to workaround instant search regression
See https://github.com/godotengine/godot-docs/issues/4787.
2021-03-28 19:11:03 +02:00
Hugo Locurcio
9becaa5480 Add Open Graph tags for better link preview on social media
This is provided by the sphinxext-opengraph extension.

This also adds a theme color property in the HTML layout file.
2021-03-18 20:34:06 +01:00
Johannes Witt
6de6863a4c Update Sphinx to 3.5.2, sphinx_rtd_theme to 0.5.1 and sphinx-tabs to 2.1.0 (#4572)
Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2021-03-17 20:32:29 +01:00
dependabot[bot]
c329e2eb90 Bump readthedocs-sphinx-search from 0.1.0rc3 to 0.1.0
Bumps [readthedocs-sphinx-search](https://github.com/readthedocs/readthedocs-sphinx-search) from 0.1.0rc3 to 0.1.0.
- [Release notes](https://github.com/readthedocs/readthedocs-sphinx-search/releases)
- [Commits](https://github.com/readthedocs/readthedocs-sphinx-search/compare/0.1.0rc3...0.1.0)

Signed-off-by: dependabot[bot] <support@github.com>
2021-02-18 06:38:29 +00:00
Hugo Locurcio
f528a844d6 Add a more descriptive custom 404 error page (#4624)
This helps users find their way back to the documentation.
2021-02-05 21:48:22 +01:00
Yuri Sizov
45d95db39f Update instant search plugin to a packaged version (#3963) 2020-09-03 18:57:59 +02:00
Max Hilbrunner
c26d33bfb4 Pin ReadTheDocs sphinx search to specific commit instead of master tip 2020-05-20 14:06:22 +02:00
Rémi Verschelde
74ec5d6942 Document installation of requirements.txt with pip
Also pin their versions to the same ones as used on RTD.

Follow-up to #3276.
2020-03-17 10:58:43 +01:00
Rémi Verschelde
f4610cc7fc Use new full-page search UI from upstream RTD
From https://readthedocs-sphinx-search.readthedocs.io,
can also be tested on https://docs.readthedocs.io.
2020-03-16 13:44:23 +01:00
Rémi Verschelde
0a633ca5a5 Install sphinx_tabs using pip requirements.txt
Upgrades us from 1.1.10 to latest (1.1.13).
2020-03-16 13:34:00 +01:00
Rémi Verschelde
cb18a9cf95 RTD: Remove restriction on Sphinx version
The referenced bug has been fixed for a while.
2018-04-10 14:17:22 +02:00
Rémi Verschelde
8f29f44436 Pin sphinx to 1.4 when generating docs to workaround search issues on RTD
Works around https://github.com/rtfd/readthedocs.org/issues/2708 and fixes #360.
Patch from @nicoddemus.
2017-04-19 16:10:47 +02:00