blender/doc/python_api/requirements.txt

sphinx==7.2.6

# Sphinx dependencies that are important
Jinja2==3.1.3
Pygments==2.17.2
docutils==0.20.1
snowballstemmer==2.2.0
requests==2.31.0

# Only needed to match the theme used for the official documentation.
# Without this theme, the default theme will be used.
furo==2024.1.29
sphinx-basic-ng==1.0.0b2

# Show a copy button (convenience only).
sphinx-copybutton==0.5.2
Docs: Python: Update Sphinx to 7.2.6 This matches what we use for the manual. Also updates corresponding dependencies. 2024-03-27 03:37:14 +00:00			`sphinx==7.2.6`
PyDoc: Update Sphinx and pin dependencies Sphinx has rather loose dependency requirements which can cause issues if we aren't careful. As a solution they recommend that you pin sphinx dependency versions 2021-06-22 20:30:07 +00:00
			`# Sphinx dependencies that are important`
Docs: Python: Update Sphinx to 7.2.6 This matches what we use for the manual. Also updates corresponding dependencies. 2024-03-27 03:37:14 +00:00			`Jinja2==3.1.3`
			`Pygments==2.17.2`
			`docutils==0.20.1`
Py Docs: Update Sphinx and dependencies - Adds python 3.10 support - Slightly improves performance 2022-06-06 03:05:35 +00:00			`snowballstemmer==2.2.0`
PyAPI Docs: Update Sphinx and theme Updates sphinx and the them to the latest versions This commit also removes 'babel' from the list of requirements, babel is only important for internationalization. 2023-08-16 21:50:37 +00:00			`requests==2.31.0`
Py Docs: Update Sphinx and dependencies - Adds python 3.10 support - Slightly improves performance 2022-06-06 03:05:35 +00:00
PyDoc: Update Sphinx and pin dependencies Sphinx has rather loose dependency requirements which can cause issues if we aren't careful. As a solution they recommend that you pin sphinx dependency versions 2021-06-22 20:30:07 +00:00			`# Only needed to match the theme used for the official documentation.`
			`# Without this theme, the default theme will be used.`
Docs: Python API: Switch theme to Furo Since moving from the Wiki we have used the `sphinx_rtd_theme` which has worked well but has become a little dated and has had slow development. This changes to use "Furo" instead. [Furo](https://github.com/pradyunsg/furo) is a lightweight theme that is responsive and has native dark mode support. Dark mode is one of the major enhancements but this change also brings: - Content is slightly larger making text and images easier to view - Site navigation and page navigation is split into two navigation trees. The site navigation is on the left and page on the right if the page has multiple headings. - Return to top button - Content is centered on the screen which helps with wide monitors - No more breadcrumbs - Remove google analytics So far the caveat that I have noticed with this is slower compile times and larger pages, this is due to the better sidebar navigation. This change also brings a lot of simplifications to customizations that we made to the `sphinx_rtd_theme`. There is still likely room for improvement in the future. Pull Request: #119684 2024-03-20 03:18:55 +00:00			`furo==2024.1.29`
Docs: Python API: Fix builds on buildbot Because sphinx-basic-ng does not have an official release on BYPI, pip could not satisfy the dependency. 2024-03-20 20:57:10 +00:00			`sphinx-basic-ng==1.0.0b2`
Docs: Python: Add copy button to code blocks Uses the sphinx-copybutton to add a copy icon to code block to quickly copy content to the clipboard. Pull Request: #119948 2024-03-30 00:39:35 +00:00
			`# Show a copy button (convenience only).`
			`sphinx-copybutton==0.5.2`