Angus Gratton
a148d8e6ba
docs: Refactor extensions into packages, update the add-ons-reference docs page
...
Includes converting some of the remaining standalone scripts into Sphinx extensions.
Make flake8 clean
2020-02-07 16:37:43 +11:00
Angus Gratton
37d5e2fba6
docs: Add "explicit only" directive & use only:: to block out some chip-specific parts of docs
2020-02-07 16:37:43 +11:00
Roland Dobai
8102996b0c
docs: Fix nwdiag dependency for documentation build
2020-02-06 12:36:47 +01:00
Angus Gratton
ef0c26bfce
doc: Limit sphinxcontrib versions to <2.0.0 as we use Sphinx 1.8.5
2019-12-11 14:34:18 +11:00
Krzysztof
27fe2006de
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-15 20:40:48 +08:00
Krzysztof Budzynski
cb87e786a5
docs: Introduced custom 404 page in readthedocs documentation to replace…
2019-03-28 01:38:31 +08:00
krzychb
57b2d5ae56
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 17:04:58 +01:00
krzychb
e1e8c36492
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-27 22:11:59 +01:00
Roland Dobai
c3d99dd2e4
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-11 08:54:37 +02:00
Roland Dobai
7cfef29eb8
Docs: Check Python packages
2018-08-30 13:20:42 +02:00
Anuj Deshpande
bd47f405a3
docs : Add support for markdown files
2018-01-15 13:58:31 +08:00
krzychb
3a1521f965
Implement ‘blockdiag - simple block-diagram image generator’ to illustrate documentation with block diagrams, sequence diagrams, activity diagrams and logical network diagrams
2017-11-07 18:17:53 +01:00
krzychb
7cc6b3c5ec
Upgraded Sphinx to latest release 1.6.5 that contains a fix to https://github.com/sphinx-doc/sphinx/issues/4041 . Upgraded Breathe to latest release 4.7.3 as well.
2017-10-31 22:57:39 +01:00
krzychb
173cce2850
docs: Included information about ESP32-WROVER module
2017-08-22 20:08:04 +02:00
krzychb
fe80e1a595
Fixed Breathe release because 'latest' introduces errors
2017-08-09 19:09:59 +02:00
krzychb
2e94b51b9c
Instructions how to setup tools and build documentation locally
2017-08-02 06:33:55 +02:00
Ivan Grokhotkov
d4982e0b64
docs: temporary downgrade Sphinx to 1.5.6 to work around Breathe issue
2017-07-27 20:43:26 +08:00
Ivan Grokhotkov
1d3626c119
docs: fix typos, build docs with gitlab CI
2016-11-01 20:08:29 +08:00
Krzysztof
ec99397c3e
Initial Sphinx / ReadTheDocs.org configuration
2016-11-01 01:20:04 +08:00
