circuitpython/requirements-doc.txt

# For docs
mypy
black
isort
twine
build
wheel
astroid
setuptools>=45
setuptools_scm

# For sphinx
sphinx!=5.2.0.post0
sphinx-autoapi
sphinx-rtd-theme
sphinxcontrib-svg2pdfconverter
sphinxcontrib-jquery
readthedocs-sphinx-search
myst-parser

# For stubs and annotations
adafruit-circuitpython-typing
build docs dynamically 2021-09-15 05:35:05 -04:00			`# For docs`
			`mypy`
			`black`
			`isort`
			`twine`
Updated how stubs are built 2023-05-09 22:01:24 -04:00			`build`
build docs dynamically 2021-09-15 05:35:05 -04:00			`wheel`
			`astroid`
Bump setuptools version Building locally I saw this message: ``` /home/jepler/.espressif/python_env/idf4.4_py3.9_env/lib/python3.9/site-packages/setuptools_scm/integration.py:27: RuntimeWarning: ERROR: setuptools==44.1.1 is used in combination with setuptools_scm>=6.x Your build configuration is incomplete and previously worked by accident! setuptools_scm requires setuptools>=45 ``` For some reason this dependency is not automatically met, e.g., by setuptools_scm specifying a versioned dependency itself! So specify it here. 2022-08-04 16:12:03 -04:00			`setuptools>=45`
Install setuptool_scm for `make check-stubs` This fixes the lengthy build-time message > setuptools_scm-6.3.2-py3.9.egg/setuptools_scm/integration.py:16: RuntimeWarning: > ERROR: setuptools==44.1.1 is used in combination with setuptools_scm>=6.x > > Your build configuration is incomplete and previously worked by accident! > > > This happens as setuptools is unable to replace itself when a activated build dependency requires a more recent setuptools version (it does not respect "setuptools>X" in setup_requires). > > > setuptools>=31 is required for setup.cfg metadata support > setuptools>=42 is required for pyproject.toml configuration support > > Suggested workarounds if applicable: > - preinstalling build dependencies like setuptools_scm before running setup.py > - installing setuptools_scm using the system package manager to ensure consistency > - migrating from the deprecated setup_requires mechanism to pep517/518 and using a pyproject.toml to declare build dependencies which are reliably pre-installed before running the build tools 2021-12-27 11:36:56 -05:00			`setuptools_scm`
build docs dynamically 2021-09-15 05:35:05 -04:00
			`# For sphinx`
avoid problematic sphinx version number for rtd theme 2022-09-25 10:10:11 -04:00			`sphinx!=5.2.0.post0`
build docs dynamically 2021-09-15 05:35:05 -04:00			`sphinx-autoapi`
			`sphinx-rtd-theme`
			`sphinxcontrib-svg2pdfconverter`
attempt to fix missing jquery in RTD 2023-03-27 17:52:01 -04:00			`sphinxcontrib-jquery`
build docs dynamically 2021-09-15 05:35:05 -04:00			`readthedocs-sphinx-search`
			`myst-parser`
add adafruit-circuitpython-typing to requirements-doc.txt 2022-02-25 16:02:17 -05:00
			`# For stubs and annotations`
			`adafruit-circuitpython-typing`