Sphinx 1.4.5 complains about some literal blocks at
kernel-documentation.rst:
Documentation/kernel-documentation.rst:373: WARNING: Could not lex
literal_block as "C". Highlighting skipped.
Documentation/kernel-documentation.rst:378: WARNING: Could not lex
literal_block as "C". Highlighting skipped.
Documentation/kernel-documentation.rst:576: WARNING: Could not lex
literal_block as "C". Highlighting skipped.
Fix it by telling Sphinx to consider them as "none" type.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/kernel-documentation.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Documentation/kernel-documentation.rst
b/Documentation/kernel-documentation.rst
index 391decc66a18..1dd97478743e 100644
--- a/Documentation/kernel-documentation.rst
+++ b/Documentation/kernel-documentation.rst
@@ -370,11 +370,15 @@ To cross-reference the functions and types defined in the
kernel-doc comments
from reStructuredText documents, please use the `Sphinx C Domain`_
references. For example::
+.. code-block:: none
+
See function :c:func:`foo` and struct/union/enum/typedef :c:type:`bar`.
While the type reference works with just the type name, without the
struct/union/enum/typedef part in front, you may want to use::
+.. code-block:: none
+
See :c:type:`struct foo <foo>`.
See :c:type:`union bar <bar>`.
See :c:type:`enum baz <baz>`.
@@ -573,6 +577,8 @@ converted to Sphinx and reStructuredText. For most DocBook
XML documents, a good
enough solution is to use the simple ``Documentation/sphinx/tmplcvt`` script,
which uses ``pandoc`` under the hood. For example::
+.. code-block:: none
+
$ cd Documentation/sphinx
$ ./tmplcvt ../DocBook/in.tmpl ../out.rst
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html
