[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[RFC PATCH 0/6] docs: integrate doc comments with Sphinx build
From: |
Paolo Bonzini |
Subject: |
[RFC PATCH 0/6] docs: integrate doc comments with Sphinx build |
Date: |
Tue, 29 Oct 2019 17:22:42 +0100 |
Hello,
this is an attempt at including kernel-doc, with small tweaks (see patch
2) to support QEMU's doc comment format, in the Sphinx documentation pipeline.
The ugly part is patch 3, which disables Sphinx's "nitpicking" (warn on
invalid cross-reference) mode. It would probably be possible to use
the nitpick_ignore configuration entry instead.
Paolo
Paolo Bonzini (6):
docs: import Linux kernel-doc script and extension
docs: tweak kernel-doc for QEMU coding standards
docs: disable sphinx warning about missing cross references
memory: adjust API documentation to (modified) kerneldoc format
docs: add memory API reference
memory: include MemoryListener documentation and some missing function
parameters
Makefile | 2 +-
docs/conf.py | 7 +-
docs/devel/memory.rst | 5 +
docs/sphinx/kernellog.py | 28 +
include/exec/memory.h | 227 +++-
scripts/kernel-doc | 2236 ++++++++++++++++++++++++++++++++++++++
6 files changed, 2495 insertions(+), 10 deletions(-)
create mode 100644 docs/sphinx/kernellog.py
create mode 100755 scripts/kernel-doc
--
2.21.0
- [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build,
Paolo Bonzini <=
- [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/10/29
- [PATCH 5/6] docs: add memory API reference, Paolo Bonzini, 2019/10/29
- [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format, Paolo Bonzini, 2019/10/29
- [PATCH 3/6] docs: disable sphinx warning about missing cross references, Paolo Bonzini, 2019/10/29
- [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters, Paolo Bonzini, 2019/10/29
- [PATCH 1/6] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, no-reply, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Peter Maydell, 2019/10/29