From: Eduardo Habkost <ehabkost@redhat.com>
To: qemu-devel@nongnu.org, Gabriel Barreto <sbarreto.gabriel@gmail.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
"Daniel P. Berrange" <berrange@redhat.com>,
"Emilio G. Cota" <cota@braap.org>,
Stefan Hajnoczi <stefanha@redhat.com>,
Cleber Rosa <crosa@redhat.com>,
Paolo Bonzini <pbonzini@redhat.com>, John Snow <jsnow@redhat.com>
Subject: [Qemu-devel] Introducing GSoC project: API Documentation Generation
Date: Mon, 20 May 2019 15:41:08 -0300 [thread overview]
Message-ID: <20190520184108.GA10764@habkost.net> (raw)
Please welcome GSoC student Gabriel Barreto. Gabriel is going to
work on QEMU API Documentation Generation[1].
Gabriel's first task is to evaluate our options for extract doc
comments from C source code and integrate them into Sphinx
documentation. I saw that Peter has experimented with kernel-doc
in the past[2][3]. Has anybody evaluated other alternatives?
(e.g. Hawkmoth[4])
[1] https://wiki.qemu.org/Google_Summer_of_Code_2019#API_documentation_generation
[2] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411643.html
[3] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411841.html
[4] https://readthedocs.org/projects/hawkmoth/
--
Eduardo
next reply other threads:[~2019-05-20 18:42 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-20 18:41 Eduardo Habkost [this message]
2019-05-20 18:48 ` [Qemu-devel] Introducing GSoC project: API Documentation Generation John Snow
2019-05-21 8:53 ` Daniel P. Berrangé
2019-05-21 9:43 ` Peter Maydell
2019-05-21 11:06 ` Daniel P. Berrangé
2019-05-21 10:55 ` Paolo Bonzini
2019-05-21 15:18 ` Markus Armbruster
2019-05-21 15:25 ` Daniel P. Berrangé
2019-05-21 15:27 ` Peter Maydell
2019-05-21 17:14 ` Paolo Bonzini
2019-05-21 20:32 ` John Snow
2019-05-21 20:37 ` Eduardo Habkost
2019-05-22 8:20 ` Paolo Bonzini
2019-05-23 12:20 ` John Snow
2019-05-24 18:34 ` Paolo Bonzini
2019-05-24 19:08 ` Eduardo Habkost
2019-05-24 20:02 ` Paolo Bonzini
2019-05-21 16:17 ` Eduardo Habkost
2019-05-21 17:14 ` Paolo Bonzini
2019-05-21 9:42 ` Peter Maydell
2019-05-21 11:01 ` Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190520184108.GA10764@habkost.net \
--to=ehabkost@redhat.com \
--cc=berrange@redhat.com \
--cc=cota@braap.org \
--cc=crosa@redhat.com \
--cc=jsnow@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=sbarreto.gabriel@gmail.com \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.