9 Commity (262acbc0a831ab1ed7b738b7986ddfc58195f750)

Autor	SHA1	Wiadomość	Data
krzychb	ed0db52f74	docs: This is a quick reference of more than a dozen and-ons and extensions prepared over the last two years to add contents, improve look & feel and cut on maintenance of the ESP-IDF documentation.	2019-02-17 20:32:50 +01:00
Angus Gratton	df4e227855	docs: Add "Creating Examples" docs page, template example README	2018-06-14 16:49:22 +10:00
krzychb	1a19747678	Getting started guides	2017-04-27 19:51:42 +02:00
Ivan Grokhotkov	15072028c4	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.	2017-01-20 17:22:47 +08:00
Krzysztof	fa3e4103ab	docs: Hyperlinks to guides	2016-11-21 10:24:12 +08:00
Krzysztof	b981b195be	Fixed broken links	2016-11-05 17:04:35 +01:00
Krzysztof	adae42fd85	API template ... - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst	2016-11-01 01:20:04 +08:00
Krzysztof	591b7caa95	Back to .md format	2016-11-01 01:20:04 +08:00
Krzysztof	41514f497a	Renamed .md to .rst	2016-11-01 01:20:04 +08:00