This series add a small sphinx extension for extraction API doc from the source files, similar to what 'kerneldoc' + 'kernel-doc' do for the kernel. It's quite simple and basic but, thanks to sphinx, already quite powerful. As such it only supports the documentation of functions and generic doc-blocks (the most important) but nothing yet to document strutures, enums, typedefs or variable. Also nothing is done to try to check if parameters in function's documentation match the real function's parameters (the idea is to add this later with the help of sparse itself). Currently, only a single file have been converted to such documention (ptrlist.c). The result can be seen on: http://sparse-doc.readthedocs.io/en/autodoc/api.html Now, the only thing that must be added is actual API and internal documentation ... ahah. Luc Van Oostenryck (6): doc: add structured doc for ptrlist.c autodoc: extract doc from the C files autodoc: convert extracted doc to reST autodoc: add a sphinx c:autodoc directive for the extracted doc autodoc: add doc from ptrlist.c autodoc: add markup to argument's references Documentation/api.rst | 11 ++ Documentation/conf.py | 10 +- Documentation/index.rst | 1 + Documentation/sphinx/cdoc.py | 266 +++++++++++++++++++++++++++++++++++ ptrlist.c | 64 +++++++-- 5 files changed, 339 insertions(+), 13 deletions(-) create mode 100644 Documentation/api.rst create mode 100755 Documentation/sphinx/cdoc.py -- 2.17.0 -- To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
