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
