mirror of
https://github.com/espressif/esp-idf.git
synced 2024-09-21 06:56:11 -04:00
2e0f8b5a70
On each documentation build (‘make html’), doxygen regenerates XML files. In addition to that, gen-dxd.py regenerates API reference files under _build/inc/. This results in Sphinx flagging about half of the input files as modified, and incremental builds taking long time. With this change, XML files generated by Doxygen are copied into docs/xml_in directory only when they are changed. Breathe is pointed to docs/xml_in directory instead of docs/xml. In addition to that, gen-dxd.py is modified to only write to the output file when contents change. Overall, incremental build time (with no source files changed) is reduced from ~7 minutes to ~8 seconds (on a particular OS X computer). Due to the way Breathe includes Doxygen XML files, there is still going to be a massive rebuild every time functions, enums, macros, structures are added or removed from the header files scanned by Doxygen, but at least individual .rst files can be edited at a much faster pace. |
||
|---|---|---|
| .. | ||
| _static | ||
| api-guides | ||
| api-reference | ||
| contribute | ||
| get-started | ||
| hw-reference | ||
| security | ||
| about.rst | ||
| check_doc_warnings.sh | ||
| conf.py | ||
| COPYRIGHT.rst | ||
| Doxyfile | ||
| gen-dxd.py | ||
| gen-kconfig-doc.py | ||
| index.rst | ||
| kconfiglib.py | ||
| link-roles.py | ||
| local_util.py | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
| resources.rst | ||
| sphinx-known-warnings.txt | ||
Documentation Source Folder
This folder contains source files of ESP-IDF documentation.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated instantly on each commit:
- Main server: https://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
- Mirror: https://dl.espressif.com/doc/esp-idf/latest/