[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension
From: |
Richard Henderson |
Subject: |
Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension |
Date: |
Fri, 14 Aug 2020 11:40:13 -0700 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.10.0 |
On 8/10/20 12:50 PM, Peter Maydell wrote:
> Some of our documentation is auto-generated from documentation
> comments in the JSON schema.
>
> For Sphinx, rather than creating a file to include, the most natural
> way to handle this is to have a small custom Sphinx extension which
> processes the JSON file and inserts documentation into the rST
> file being processed.
>
> This is the same approach that kerneldoc and hxtool use.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Changes v4->v5: match the changes in parameters to the
> various visit_* methods from commit 7b3bc9e28f366
> ---
> docs/conf.py | 6 +-
> docs/sphinx/qapidoc.py | 504 +++++++++++++++++++++++++++++++++++++++++
> MAINTAINERS | 1 +
> 3 files changed, 510 insertions(+), 1 deletion(-)
> create mode 100644 docs/sphinx/qapidoc.py
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
r~
- Re: [PATCH v5 02/20] qapi: Fix indentation, again, (continued)
- [PATCH v5 03/20] qapi/block-core.json: Fix nbd-server-start docs, Peter Maydell, 2020/08/10
- [PATCH v5 04/20] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/08/10
- [PATCH v5 05/20] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/08/10
- [PATCH v5 06/20] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- [PATCH v5 07/20] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/08/10
- [PATCH v5 08/20] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/08/10
- [PATCH v5 10/20] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/08/10
- Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension,
Richard Henderson <=
- [PATCH v5 11/20] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/08/10
- [PATCH v5 12/20] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/08/10
- [PATCH v5 13/20] qga/qapi-schema.json: Add some headings, Peter Maydell, 2020/08/10
- [PATCH v5 15/20] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/08/10
- [PATCH v5 14/20] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/08/10
- [PATCH v5 16/20] Makefile: Remove redundant Texinfo related rules, Peter Maydell, 2020/08/10
- [PATCH v5 18/20] Remove Texinfo related files from .gitignore and git.orderfile, Peter Maydell, 2020/08/10
- [PATCH v5 17/20] scripts/texi2pod: Delete unused script, Peter Maydell, 2020/08/10
- [PATCH v5 19/20] configure: Drop texinfo requirement, Peter Maydell, 2020/08/10
- [PATCH v5 20/20] Remove texinfo dependency from docker and CI configs, Peter Maydell, 2020/08/10