[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 0/3] Use Doxygen and sphinx for html documentation
- To: Luca Fancellu <luca.fancellu@xxxxxxx>, <xen-devel@xxxxxxxxxxxxxxxxxxxx>
- From: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
- Date: Tue, 6 Apr 2021 12:53:30 +0100
- Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=citrix.com; dmarc=pass action=none header.from=citrix.com; dkim=pass header.d=citrix.com; arc=none
- Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=uBse7rk8WKSz7q06G/Wy075gUEWHCDjkTyYk3YEELi8=; b=aqilivYbrIF/wcx46B2qPUytR8m+MC173wTke1tL7JCmKJhYTbx7ZDv3/wYiy1JYIkw6bcFB9FrHh+W9lBzNWV4w0LhmHc7Dzq7x6dwbfP9w1128BOGTUJUUbfV+H/yf+4GorRNb/fkoe2MwPRQfnsFjbKSURxcPI/SPCFREJnGedK80D2F73zGY1WyCsq81zYJWPgnD+y68T0eYrp8JpYWFnjCw7Jw0gph8nTZgxC1XKXEwLK5gVh8EHTw0wLd2L6Tl4vlhxopiM2FuJX1xAG9myoLaSZ4taThvt9BNwDPDL5ocRBu1MQpfBeX/euiSD6s1fc6EOuUI+H+TkbiG/g==
- Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=gX/DwznogCU6b9YFz3u2F2hVFhw3s4hBlnD7VzHQs1z3P62n1XmgHumdFuzHZSBJSw2LU2qcCZ3ozfr0Zw/Kt01fGTFNZ+pwHuMOud/NRlgPWjX6My4AuGeqzwE5nrQTi7/Qse2yJ/UyEIQeg7jlwf0Lk5vDUAZZ8OYUs3z5g0x4IzWCKO4N2Ftvq2iuRxcY447sc677tFqdA4xQZztmTmgyyy8RlKKHlZnupMdwmAFQ/0JEUQRjDDgKqzU/M1vf7KTHUCe3IgHfpCbufl+XLdn/ot/47l3rJquYLg806sSn4hZxztCu2eBynF8XejuY7fjH5494nZn9xhwgdk4nWg==
- Authentication-results: esa1.hc3370-68.iphmx.com; dkim=pass (signature verified) header.i=@citrix.onmicrosoft.com
- Cc: <bertrand.marquis@xxxxxxx>, <wei.chen@xxxxxxx>, George Dunlap <george.dunlap@xxxxxxxxxx>, Ian Jackson <iwj@xxxxxxxxxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Wei Liu <wl@xxxxxxx>
- Delivery-date: Tue, 06 Apr 2021 11:53:59 +0000
- Ironport-hdrordr: A9a23:BZnfyKmOJ2gUJLQKLHIl0sJkNdTpDfOlj2dD5ilNYBxZY6Wkvu iUtrAyyQL0hDENWHsphNCHP+26TWnB8INuiLN9AZ6LZyOjnGezNolt4c/ZwzPmEzDj7eI178 1dWoBEIpnLAVB+5PyQ3CCRGdwt2cTC1aiui/vXwXsFd3AQV4hLxW5Ce2WmO2dxQxRLAod8MZ Ka6NZOqTbIQwVsUu2QAH4ZU+/f4+DajZ6OW29NOzcLyimryQmp5rnzDgSC0n4lPw9n7L8+/Q H+4mvEz4q5tfXT8H7h/k/Vq69bgd7wjuZEbfb88vQ9DhXJpkKWaJ96W7uE1QpF7d2HzFoxit HDr1MBEq1ImhXsV1q4qxfsxAXsuQxGgxCN9XaijXTuusD/Tj4hYvAx/L5xSAfT6EYrobhHoc B29l+ZrJZeAFfhmynw9rHzJnVXv3e0unYrnKoviWVeW+IlGdpshLEYlXk0LL4wWAbBrKw3Gu hnC8/RoNxMd0mBUnzftm5zhPSxQ3UaBH69Mwc/k/3Q9wITsGFyzkMeysBatGwH7ogBR55N4P mBGrh0lYtJUtQdYctGdak8aPryLlaIbQPHMWqUL1iiProAIWjxp5n+56hww+22ZpoSzt8XlI 7aWF1V8U4+EnieSPGm7dluyFTgUW+9VTPixoV1/J5ioIDxQ7LtLGmNU1Yrn8y8o+gOA8HSVv qpUagmQMPLHC/LI8Jkzgf+U55dJT01S8sOoOs2XFqIv4bKJ+TRx67mWceWAICoPScvW2v5DH dGdiP0Pt984keiXWK9hBDQXnjqa1Hu5J4YKtmew8EjjKw2cqFcuAkcjlq0ouuRLydZj6AwdE xiZLX9kq26omGy9X3S73pgPwdcCko92sShb1p64Ssxd2/ke7cKvNuSPUpI2mGcGxN5R8TKVB JEq09v4qKxJZyIzSUkA9aqW1jqy0c7lTavddMxi6eD7cDqdtcEFZ4gQrV2DhiOPQdygxxWpG BKbxIkSkfTGij1s7isiIUZCYjkBp5BqTbuBfQRiHrE8W2AuMkkRxIgLkOTeP/SpTxreh15qR la9bQFjL+JhDC1QFFP/NgQARlrc2SYALVPEQKfQp5b84qbND1YRXuWhDCclhE4cnfr8UJXnW D6MSiIY5jwcyVgk2Ed3aDw/FxucGKBO0p2d3BhqIV4UX/Lo3BpzIawF+OO+nrUblsJ2ecGNj 7ZJTMUPwN13tiyvSTl7wqqBDEjxp80OPbaA6lme7bP2mm1IInNka0dBfdb8NJkM9/p29V7J9 63akuQLDniDfku1BHQrnE5ODNsoH1hiOj2wnTenRqF9W96BeCXLEVtRrkdLd3Z52/4R+yQ2J E8id4up+O/Pmj4d9bu89CeUxdTbhfI5WKmReAhrp5Z+bg/s7Z+BJHXWzrF3nMv5mRLEO7k0E cFBKhr6rHIPYFiO9EIcyVC51wziZCBKlAovgGeOJ50QXg9y3vAe9WH7LrDpeBxXgmPpA7sNU Ke9CMY9fHfRCeH3aMbDaV1IWk+UjlN1F1yuOeZM4vXA0G2cusG+lywOHq0aqVcR6iIAq94lG cO3/iY2+uMMzPl0wXRtyZhKq1A82y7Udq/aTj8aNJg4pi/IxCQmaOk7864kSfvRTa6Y0oeg5 dZdUZ4VLUxthAyyIst0iazTaTrokUq11tGiAsX6GLQ5g==
- Ironport-sdr: 1gfjigUhXjOQy7/TtnNjDyAsFOSFAXxX8YOu+DcE6JV0rZbRSNCAIqr2OasrgkVDgJYEr0Zuyl TuN/BQSQgqv/GsNgKhre4ExzG3yV7WsEHRV4Hsvy30HYKPW8L4KWTzfp9HuthhYRRyiNhSNmJO hWYNYFOQVEds5vvoWwsg6hoU6MPoCgw4nyhoYuty/a0pRONVH1A9WNmunXmc/56TysnyRPCT++ v47vFlTcOXN8mgeoBYRqOthlrwt2gn5UFNern1d57nwVyhS5wq+3j0pXDSShLJjGz7SUOUsvOl VAQ=
- List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
On 06/04/2021 11:36, Luca Fancellu wrote:
> This serie introduce doxygen in the sphinx html docs generation.
> One benefit is to keep most of the documentation in the source
> files of xen so that it's more maintainable, on the other hand
> there are some limitation of doxygen that must be addressed
> modifying the current codebase (for example doxygen can't parse
> anonymous structure/union).
>
> To reproduce the documentation xen must be compiled because
> most of the headers are generated on compilation time from
> the makefiles.
>
> Here follows the steps to generate the sphinx html docs, some
> package may be required on your machine, everything is suggested
> by the autoconf script.
> Here I'm building the arm64 docs (the only introduced for now by
> this serie):
>
> ./configure
> make -C xen XEN_TARGET_ARCH="arm64" CROSS_COMPILE="aarch64-linux-gnu-"
> menuconfig
> make -C xen XEN_TARGET_ARCH="arm64" CROSS_COMPILE="aarch64-linux-gnu-"
> make -C docs XEN_TARGET_ARCH="arm64" sphinx-html
>
> now in docs/sphinx/html/ we have the generated docs starting
> from the index.html page.
Do you have a sample rendered output?
The plan was to try and use Linux's kernel-doc plugin for Sphinx, which
is very doxygen-like. Did you experiment with this option?
~Andrew
|
