Re: [PATCH 0/3] Use Doxygen and sphinx for html documentation

[Luca Fancellu <luca.fancellu@xxxxxxx>]

> On 7 Apr 2021, at 14:07, Julien Grall <julien@xxxxxxx> wrote:
> 
> 
> 
> 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
> 
> I have tried this instruction and got:
> 
> make: Entering directory '/home/ANT.AMAZON.COM/jgrall/works/oss/xen/docs'
> xen.doxyfile
> make: xen.doxyfile: Command not found
> Makefile:67: recipe for target 'sphinx-html' failed
> make: *** [sphinx-html] Error 127
> make: Leaving directory '/home/ANT.AMAZON.COM/jgrall/works/oss/xen/docs'
> 
> AFAICT, $DOXYGEN will only get defined when sphinx-build is installed.
> When sphinx-build is not installed SPHINXBUILD will be equal to 'no', but the 
> Makefile check for emptiness.
> 

Hi Julien,

Thank you for spotting it, I’ll fix it in the v2 patch

Cheers,
Luca

> Cheers,
> 
> -- 
> Julien Grall