Wykres commitów

38 Commity (8c756dad23eaa7de2e1af920a5fe8a6915f48497)

Autor SHA1 Wiadomość Data
Marius Vikhammer c8617fe965 docs: fix all doxygen warnings
Doxygen warnings would previously not result in a failed pipeline.
Fixed this as well as all current warnings.
2022-05-12 14:50:03 +08:00
Marius Vikhammer 197be02748 docs: update esp-docs 1.0.0
Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-25 12:07:11 +08:00
Marius Vikhammer a4c71c47fc docs: update esp-docs version to 0.2.4
Fixes build issues due to latest Jinja version breaking Sphinx
2022-04-06 21:03:59 +08:00
Marius Vikhammer a6543f0d21 docs: fix broken references to misc API functions and types. 2022-03-27 16:46:57 +08:00
Marius Vikhammer f018d3f2f0 docs: update esp-docs, rename esp8684 to esp32c2 2022-01-21 09:26:35 +08:00
Marius Vikhammer 82325f6037 docs: update docs to be able to build with esp8684 2021-12-20 10:32:49 +08:00
Marius Vikhammer cf0e995fa9 docs: bump esp-docs version to 0.1.1 2021-09-06 14:55:04 +08:00
Marius Vikhammer 7411321603 docs: update to use esp-docs 2021-08-24 08:56:48 +08:00
Marius Vikhammer e8b7d2ca08 docs: add warning for outdated versions 2021-04-27 09:02:11 +08:00
Krzysztof Budzynski 632b5c40e6 Revert "Merge branch 'doc/use_sphinx_reredirect_extension' into 'master'"
This reverts merge request !13293
2021-04-23 13:44:40 +08:00
Darian Leung 2be772af1c Sphinx uses reredirect extension
This commit removes the custom HTML rediiect extension and uses
the sphinx-reredirect extension instead. The sphinx-reredirect
extension allows for redirection to external links as well as
support for wildcards.
2021-04-23 00:02:30 +08:00
Marius Vikhammer 4e9d810dfb Docs: build doc with new layout for target and version select 2021-03-12 16:15:56 +08:00
dependabot[bot] 88aa3c2463 docs: bump cairosvg from 2.4.2 to 2.5.1 in /docs
Bumps [cairosvg](https://github.com/Kozea/CairoSVG) from 2.4.2 to 2.5.1.
- [Release notes](https://github.com/Kozea/CairoSVG/releases)
- [Changelog](https://github.com/Kozea/CairoSVG/blob/master/NEWS.rst)
- [Commits](https://github.com/Kozea/CairoSVG/compare/2.4.2...2.5.1)

Signed-off-by: dependabot[bot] <support@github.com>

Closes https://github.com/espressif/esp-idf/pull/6365
2021-01-13 19:41:16 +11:00
martin.gano 7a9abe3ec5 add chart of version support to version.rst 2020-09-09 11:32:44 +02:00
Krzysztof 1f565c2313 docs: Provide missing python requirement 2020-08-29 02:50:55 +08:00
Marius Vikhammer ccdd3d3db8 docs: update sphinx_idf_theme documentation
Bump CI doc-env docker image to v5
2020-07-06 10:45:43 +08:00
Marius Vikhammer 8a3d806798 doc: update CI to build PDF 2020-04-15 17:14:27 +08:00
Angus Gratton 416076665b docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer 2020-03-16 14:36:23 +11:00
Angus Gratton 291735c7dd docs: Move to Python 3.5+ and Sphinx 2.3 2020-02-07 16:47:50 +11:00
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