|
| From: | John Snow |
| Subject: | Re: [Qemu-devel] Introducing GSoC project: API Documentation Generation |
| Date: | Mon, 20 May 2019 14:48:51 -0400 |
| User-agent: | Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.6.1 |
On 5/20/19 2:41 PM, Eduardo Habkost wrote: > 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/address@hidden/msg411643.html > [3] https://www.mail-archive.com/address@hidden/msg411841.html > [4] https://readthedocs.org/projects/hawkmoth/ > Gabriel, welcome! This has been something that has been bothering me a LOT lately and I hope we'll be able to work together to improve the state of things. Please let us know if you need any help. --js
| [Prev in Thread] | Current Thread | [Next in Thread] |