summaryrefslogtreecommitdiff
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorNĂ­colas F. R. A. Prado <nfraprado@protonmail.com>2020-09-03 00:58:19 +0000
committerJonathan Corbet <corbet@lwn.net>2020-09-03 13:50:40 -0600
commitd82b1e833e7cf4265b88287f469454a66afe95d8 (patch)
tree4ddcddd78090933be57ee5ed6636b6be70f68e8c /Documentation/doc-guide
parentf67281a72b30024b376ec3c2780bdfb777395c09 (diff)
docs: Add automatic cross-reference for C types
In order to cross-reference C types in the documentation, Sphinx requires the syntax :c:type:`type_name`, or even :c:type:`struct type_name <type_name>` in order to have the link text different from the target text. Extend automarkup to enable automatic cross-reference of C types by matching any "struct|union|enum|typedef type_name" expression. This makes the documentation's plain text cleaner and adds cross-reference to types without any additional effort by the author. Signed-off-by: NĂ­colas F. R. A. Prado <nfraprado@protonmail.com> Link: https://lore.kernel.org/r/20200903005747.3900333-2-nfraprado@protonmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
0 files changed, 0 insertions, 0 deletions