Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-08-18 06:35:35 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
28021365952e55fe276771e2e1526d9597b40f2d
esp-idf/docs
History
Marius Vikhammer 2802136595 doc: fall back to CI_COMMIT_REF_NAME as a branch name 
In some cases gen_version_specific_includes.py would fail to find a branch/tag name for a commit
and would fall back to using commit SHA-1.

This should never happen in docs that should be published as we use the branch/tag name to generate
example commands for our users. E.g. "git clone -b $branch_name"

Closes https://github.com/espressif/esp-idf/issues/5657
2020-07-30 12:25:59 +08:00
..
_static
Merge branch 'feature/coredump_data_in_elf_format_doc_update' into 'master'
2020-05-28 02:25:47 +08:00
en
Merge branch 'doc/freertos_backport_v4.2' into 'release/v4.2'
2020-07-27 23:00:47 +08:00
extensions
doc: custom list filter directive
2020-02-20 18:08:05 +08:00
idf_extensions
doc: fall back to CI_COMMIT_REF_NAME as a branch name
2020-07-30 12:25:59 +08:00
latex_templates
doc: add latex and PDF generation to build_docs
2020-04-15 17:14:22 +08:00
zh_CN
docs: change redirection link in get-started
2020-07-22 16:49:00 +08:00
build_docs.py
build_docs: fix incorrect arguments for linkcheck
2020-07-27 15:14:59 +08:00
check_lang_folder_sync.sh
global: use '/usr/bin/env bash' instead of '/usr/bin/bash' in shebangs
2020-04-03 01:10:02 +02:00
conf_common.py
doc: Fix passing of build macros to Doxygen
2020-07-10 14:53:15 +10:00
Doxyfile
docs: Redirect all of Doxygen stderr to the warnings log
2020-07-10 14:53:16 +10:00
doxygen-known-warnings.txt
docs: Resolve doxygen & Sphinx warnings
2020-02-07 16:37:45 +11:00
get_github_rev.py
docs: add 'edit-on-github' link to html theme
2020-05-06 17:25:23 +08:00
page_redirects.txt
Add redirect link from user-guide-kaluga-1-v1.2 to user-guide-esp32-s2-kaluga-1-kit
2020-05-18 17:28:03 +08:00
README.md
docs: use new sphinx_idf_theme theme, add variables to allow theme to build version footer
2020-03-16 14:36:23 +11:00
requirements.txt
docs: update sphinx_idf_theme documentation
2020-07-06 10:55:32 +08:00
sanitize_version.py
docs: deploy docs to production server from CI
2020-03-16 14:36:23 +11:00
sphinx-known-warnings.txt
docs: fix check_docs not working for multiple builders
2020-07-06 12:27:02 +08:00
TEMPLATE_EXAMPLE_README.md
examples: Update system examples README
2019-08-28 16:19:40 +08:00

README.md

Documentation Source Folder

This folder contains source files of ESP-IDF documentation available in English and 中文.

The sources do not render well in GitHub and some information is not visible at all.

Use actual documentation generated within about 20 minutes on each commit:

Hosted Documentation

The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.

Building Documentation

The documentation build requirements Python 3 and running the wrapper ./build_docs.py tool. Running ./build_docs.py --help will give a summary of available options.

See Documenting Code in the ESP-IDF Programming Guide for full information about setting up to build the docs, and how to use the ./build_docs.py tool.