Skip to content
  • Peter Maydell's avatar
    4078ee54
    docs/sphinx: Add new qapi-doc Sphinx extension · 4078ee54
    Peter Maydell authored
    
    
    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: default avatarPeter Maydell <peter.maydell@linaro.org>
    Message-Id: <20200925162316.21205-8-peter.maydell@linaro.org>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    [Comment and doc string formatting tweaked, unused method dropped,
    a few line breaks tweaked to follow PEP 8 more closely, MAINTAINERS
    section QAPI updated]
    Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
    4078ee54
    docs/sphinx: Add new qapi-doc Sphinx extension
    Peter Maydell authored
    
    
    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: default avatarPeter Maydell <peter.maydell@linaro.org>
    Message-Id: <20200925162316.21205-8-peter.maydell@linaro.org>
    Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
    [Comment and doc string formatting tweaked, unused method dropped,
    a few line breaks tweaked to follow PEP 8 more closely, MAINTAINERS
    section QAPI updated]
    Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Loading