diff options
author | Tom Hiller <thrilleratplay@gmail.com> | 2018-07-28 17:38:54 -0400 |
---|---|---|
committer | Philipp Deppenwiese <zaolin.daisuki@gmail.com> | 2018-09-30 03:18:05 +0000 |
commit | ffe6d5415186ece9577c3bfad6d0fc8dd653705e (patch) | |
tree | 6155b4cef0ceb4dfde3a04608e75d667d9563fc6 /.checkpatch.conf | |
parent | e180825080ae13e990ef4b789806a02b0cc1eda5 (diff) |
Documentation: Disable auto_doc_ref
According to recommonmark's documentation the enable_auto_doc_ref is deprecated.
This is not true, as it's broken with Sphinx 1.6+ commit
12d639873953847de31ec99742b42e50e89ed58c.
recommonmark bug report is here: https://github.com/rtfd/recommonmark/issues/73
Instead of using this feature, which doesn't support top level directories in
the relative document path anyway, use the TOC tree or inline RST code.
Disable auto_doc_ref and document how to reference documents.
Change-Id: I9319985b504c4215c33ebbeb9c38317b9efcb283
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/28550
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Tom Hiller <thrilleratplay@gmail.com>
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Diffstat (limited to '.checkpatch.conf')
0 files changed, 0 insertions, 0 deletions