esp-idf/docs/requirements.txt

# This is a list of python packages used to generate documentation. This file is used with pip:
# pip install --user -r requirements.txt
#
sphinx>=1.8.4
breathe==4.11.1
sphinx-rtd-theme
sphinx-notfound-page
sphinxcontrib-blockdiag>=1.5.5, <2.0.0
sphinxcontrib-seqdiag>=0.8.5, <2.0.0
sphinxcontrib-actdiag>=0.8.5, <2.0.0
sphinxcontrib-nwdiag>=0.9.5, <2.0.0
blockdiag>=1.5.4, <2.0.0
seqdiag>=0.9.6, <2.0.0
actdiag>=0.5.4, <2.0.0
nwdiag>=1.0.4, <2.0.0
recommonmark
future>=0.16.0 # for ../tools/gen_esp_err_to_name.py
docs: fix typos, build docs with gitlab CI 2016-11-01 08:08:29 -04:00			`# This is a list of python packages used to generate documentation. This file is used with pip:`
Encourage to install python packages without administrative rights Using 'sudo pip install' can cause a lot of problems because usually there are a couple of Python interpreters installed. This fix encourages developers to use `pip install --user` instead which is safer. 2018-09-07 03:14:05 -04:00			`# pip install --user -r requirements.txt`
docs: fix typos, build docs with gitlab CI 2016-11-01 08:08:29 -04:00			`#`
docs: Upgraded sphinx package version to prevent build failures on readthedocs site. Upgraded versions of other packages that are used during documentation build. 2019-03-19 11:47:39 -04:00			`sphinx>=1.8.4`
Fixed Breathe version to avoid docs build failure on ReadTheDocs server. Provided RTD project configuration file to be able to select python version for specific to esp-idf release. 2019-05-03 09:18:18 -04:00			`breathe==4.11.1`
docs: fix typos, build docs with gitlab CI 2016-11-01 08:08:29 -04:00			`sphinx-rtd-theme`
docs: Introduced custom 404 page in readthedocs documentation to replace… 2019-03-27 13:38:31 -04:00			`sphinx-notfound-page`
doc: Limit sphinxcontrib versions to <2.0.0 as we use Sphinx 1.8.5 2019-12-10 22:34:18 -05:00			`sphinxcontrib-blockdiag>=1.5.5, <2.0.0`
			`sphinxcontrib-seqdiag>=0.8.5, <2.0.0`
			`sphinxcontrib-actdiag>=0.8.5, <2.0.0`
			`sphinxcontrib-nwdiag>=0.9.5, <2.0.0`
Docs: Fix sphinxcontrib dependencies 2020-02-13 08:48:52 -05:00			`blockdiag>=1.5.4, <2.0.0`
			`seqdiag>=0.9.6, <2.0.0`
			`actdiag>=0.5.4, <2.0.0`
			`nwdiag>=1.0.4, <2.0.0`
docs : Add support for markdown files 2018-01-11 01:52:54 -05:00			`recommonmark`
Docs: Check Python packages 2018-08-28 14:01:25 -04:00			`future>=0.16.0 # for ../tools/gen_esp_err_to_name.py`