mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Ivan Grokhotkov 632bd0bb4f Merge branch 'feature/docs_gh_link_roles' into 'master' docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: ``` - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir ``` A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests. See merge request !455		2017-01-20 17:47:34 +08:00
..
_static	doc: Documenting Code clean up	2016-11-21 10:24:12 +08:00
api	Merge branch 'feature/docs_gh_link_roles' into 'master'	2017-01-20 17:47:34 +08:00
security	Typo corrections	2017-01-17 21:12:54 +01:00
build-system.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
conf.py	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
contributing.rst	Link to file a folder up	2016-11-01 01:20:04 +08:00
contributor-agreement.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
COPYRIGHT.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
core_dump.rst	esp32: Fixes issues discussed during code review of MR!341	2017-01-12 19:38:19 +03:00
deep-sleep-stub.rst	Fixed section header style	2016-11-05 17:06:55 +01:00
documenting-code.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
Doxyfile	Initial mDNS component and example	2017-01-13 12:12:43 +02:00
doxygen_xml_to_rst.xslt	rmt: add documentation	2016-11-22 01:44:23 +08:00
eclipse-setup.rst	docs: fix typos, build docs with gitlab CI	2016-11-01 20:08:29 +08:00
esp32.cfg	Fix issued raised in the merge request	2016-08-30 11:30:03 +08:00
general-notes.rst	docs: fix data RAM size	2017-01-17 01:18:23 +08:00
index.rst	Merge branch 'bugfix/docs_cleanup' into 'master'	2017-01-19 00:33:31 +08:00
link-roles.py	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
linux-setup.rst	docs: update toolchain version	2017-01-11 15:03:14 +08:00
macos-setup.rst	docs: fix macOS setup instructions	2017-01-16 02:38:31 +08:00
make-project.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
Makefile	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
openocd.rst	Simplified "Installing OpenOCD" with git clone --recursive	2016-11-17 10:19:42 +11:00
partition-tables.rst	Build system: Add `make erase_flash` target	2016-12-20 10:00:04 +11:00
README.md	Docs folder info, ref. https://github.com/espressif/esp-idf/issues/243 ; Doc title fix	2017-01-17 20:37:27 +01:00
repo_util.py	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00
requirements.txt	docs: fix typos, build docs with gitlab CI	2016-11-01 20:08:29 +08:00
style-guide.rst	Fixed link so it can render by Sphinx	2016-11-10 22:44:59 +01:00
ulp.rst	Updated relative paths to included documents	2017-01-16 23:08:35 +01:00
unit-tests.rst	esp32: add unit testing doc	2017-01-18 17:08:20 +08:00
windows-setup.rst	docs: use custom roles to generate GitHub links	2017-01-20 17:22:47 +08:00

README.md

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: http://esp-idf.readthedocs.io/ or http://esp-idf.rtfd.io/
Mirror: https://dl.espressif.com/doc/esp-idf/latest/