]> granicus.if.org Git - esp-idf/commit
docs: generate documentation for Kconfig options
authorIvan Grokhotkov <ivan@espressif.com>
Sun, 20 Aug 2017 16:09:12 +0000 (00:09 +0800)
committerIvan Grokhotkov <ivan@espressif.com>
Tue, 22 Aug 2017 07:12:34 +0000 (15:12 +0800)
commita2f4f2999d7a7244bfba099d37d2ff8a717d0a54
treed5b41da196f4dfaa5520ed324adcc18ecdf571d5
parentfb43948413a3752613ff17bbd9c3bce1d5452109
docs: generate documentation for Kconfig options

This adds a simple script which parses Kconfig files using Kconfiglib
and emits ReST document with the list of all options. For each option
a link target is generated, to make it possible to link to any Kconfig
option from the rest of the documentation.
Since Kconfiglib is not on PyPI, the latest version (45f87b9d) is
bundled into the docs directory.
docs/api-guides/build-system.rst
docs/api-reference/index.rst
docs/api-reference/kconfig.rst [new file with mode: 0644]
docs/conf.py
docs/gen-kconfig-doc.py [new file with mode: 0755]
docs/kconfiglib.py [new file with mode: 0644]