arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-06-10 14:42:08 +03:00
Code Activity

Docs - fix sphinx v8 builds (#9235)

Browse Source 
abnormal version selection w/ nbsphinx causing us to fall down to 5.x.x
venv install specific versions, fix arguments provided to the sphinx-build
This commit is contained in:
Max Prokhorov
2025-03-11 00:04:47 +03:00
committed by GitHub
parent 1a13ab95fb
commit 7af5246c12
5 changed files with 14 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
.github/workflows/documentation.yml vendored
View File

@ -24,5 +24,8 @@ jobs:
python-version: '3.x' python-version: '3.x'
- name: Build documentation - name: Build documentation
run: | run: |
pip install --user -r doc/requirements.txt pushd doc/
bash ./tests/ci/build_docs.sh python3 -mvenv _venv
./_venv/bin/pip install -r requirements.txt
env SPHINXBUILD=$(pwd)/_venv/bin/sphinx-build ../tests/ci/build_docs.sh
popd

2
doc/Makefile
View File

@ -2,7 +2,7 @@
# #
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = -W --keep-going -n SPHINXOPTS = --fail-on-warning --nitpicky
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
SPHINXPROJ = ESP8266ArduinoCore SPHINXPROJ = ESP8266ArduinoCore
SOURCEDIR = . SOURCEDIR = .

6
doc/conf.py
View File

@ -71,7 +71,7 @@ language = 'en'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path # This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_venv', '_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
@ -162,11 +162,7 @@ linkcheck_anchors_ignore = ["/#!"]
# #
# on_rtd is whether we are on readthedocs.org # on_rtd is whether we are on readthedocs.org
env_readthedocs = os.environ.get('READTHEDOCS', None) env_readthedocs = os.environ.get('READTHEDOCS', None)
print(env_readthedocs)
if not env_readthedocs: # only import and set the theme if we're building docs locally if not env_readthedocs: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme' html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

14
doc/requirements.txt
View File

@ -1,10 +1,8 @@
# Requirements file for pip # Requirements file for pip
# list of Python packages used in documentation build # list of Python packages used in documentation build
sphinx sphinx>=8.1.2,<9.0.0
sphinx-rtd-theme sphinx-rtd-theme>=3.0.2,<4.0.0
breathe breathe>=4.36.0,<5.0.0
nbsphinx nbsphinx>=0.9.7,<1.0.0
docutils<0.17 testresources>=2.0.1,<3.0.0
testresources pygments>=2.19.1,<3.0.0
#at the time of writing, requirement is pygments<3,>=2.4.1
pygments>=2.4.1

2
tests/ci/build_docs.sh
View File

@ -5,4 +5,4 @@
set -ev set -ev
root=$(git rev-parse --show-toplevel) root=$(git rev-parse --show-toplevel)
env SPHINXOPTS="-W" make -C $root/doc html make SPHINXOPTS="--fail-on-warning" SPHINXBUILD="${SPHINXBUILD:?sphinx-build}" -C $root/doc html