Marius Vikhammer
bdfda351bd
build docs: enable building of S3 docs
...
* Added suport for building esp32s3 docs
* Fixed all related warnings
* Activated building of S3 docs for build HTML fast CI job
2021-06-09 09:30:36 +08:00
Marius Vikhammer
89179dc286
docs: add fast build feature and activate it in CI
...
Adds feature for skipping include of doxygen headers into sphinx build
when env variable is set.
Builds incomplete docs (no function API documention)
but speeds up building (20min to 1<min).
Add this fast build as the default way of building docs in CI on
non protected branches.
2021-04-28 16:32:35 +08:00
Marius Vikhammer
548fd02d10
docs: initial update of programming guide for C3
...
Updates "front page" content, get-started, and api-guides with C3 content
Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
Fu Hanxi
0146f258d7
style: format python files with isort and double-quote-string-fixer
2021-01-26 10:49:01 +08:00
Marius Vikhammer
9b552ce004
docs: add warning for doxygen version
...
Running with a newer doxygen version than what's
used in CI may raise warnings locally that are not
present when built by CI
2020-09-03 13:48:40 +08:00
Angus Gratton
d02a9bddf2
docs: Update Versions file in line with the latest Support Policy document
2020-08-27 20:32:44 +10:00
Andrei Gramakov
dd192a2113
docs: adds to build_docs.py an encoding check suitable for windows
2020-08-11 13:52:21 +02:00
Marius Vikhammer
ba546a0d91
docs: Adds CI tests for the doc building process.
...
Adds test_sphinx_idf_extensions.py and test_docs.py for testing the documentation building process.
Both are run as a part of the host_test stage.
Closes IDF-1648
2020-07-28 17:48:19 +08:00
Marius Vikhammer
c54e9d9d5c
build_docs: fix incorrect arguments for linkcheck
2020-07-24 19:27:52 +08:00
Marius Vikhammer
67ea59d605
docs: fix check_docs not working for multiple builders
...
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.
Closes IDF-1659
2020-05-29 20:10:18 +08:00
Marius Vikhammer
a316082f53
docs: support building a subset of the documentation with build_docs
...
Closes IDF-1688
2020-05-22 15:01:40 +08:00
Marius Vikhammer
407275f681
doc: add latex and PDF generation to build_docs
...
Adds options for generating tex-files and PDFs when building documentation
Closes IDF-1217
Closes IDF-1464
2020-04-15 17:14:22 +08:00
Angus Gratton
1a2ddcb77a
docs: deploy docs to production server from CI
2020-03-16 14:36:23 +11:00
Supreet Deshpande
ef7b5ff9e4
bugfix/build_docs_add_warning_check: Added null value check for warnings
2020-02-12 12:32:41 +05:30
Angus Gratton
54e7cb4d8b
docs: Require UTF-8 as default encoding to build docs
...
Making everything work for both docs & non-docs builds with Py2 is too fiddly otherwise.
2020-02-07 16:47:50 +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
d03af45731
docs: flake8 fixes
2020-02-07 16:37:45 +11:00
Angus Gratton
4bfd004c83
build_docs gh-linkcheck: Use Python, ignore links to master branch SUPPORT_POLICY.md
2020-02-07 16:37:45 +11:00
Anton Maklakov
775448c792
docs: Make Python 3 compatible
2020-02-07 16:37:45 +11:00
Angus Gratton
844bdd8154
docs: Allow incremental builds
2020-02-07 16:37:45 +11:00
Angus Gratton
11fac8637a
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11:00
Anton Maklakov
b9effd8c06
fixup build_docs.py, show doxygen and sphinx warnings together
2020-02-07 16:37:44 +11:00
Anton Maklakov
fb3edc9c87
docs: Add features to build_docs.py: check warnings, check links, check GH links
...
The old check_doc_warnings.sh was deleted
2020-02-07 16:37:44 +11:00
Angus Gratton
50fcdf115d
doc builder: Change default to 1 job per Sphinx instance, add a warning
2020-02-07 16:37:44 +11:00
Angus Gratton
35db219be2
docs: Manage parallel sphinx-build runs with optional parallel jobs within them
2020-02-07 16:37:44 +11:00
Marius Vikhammer
105567d077
doc: updated peripherals api-reference for s2
2020-02-07 16:37:44 +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
cbede3a3a4
docs: Try to enable parallel reads & writes
...
Reads still single threaded in Sphinx 1.8.5, though.
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
Angus Gratton
e6211c7864
docs: add new top-level docs builder that builds docs for a single chip
2020-02-07 16:37:43 +11:00
