Generating Package/Image Developer Documentation

Generating Package/Image Developer Documentation

[Koehler, Yannick]

Hi,

  I would like to know if there exists a way to build a set of package Developer documentation.  For example, many of our package are written in C/C++ and use Doxygen to generate API reference.  I understand that yocto/bitbake has some support for user documentation such as info and man pages.  I was wondering if there was more to it.

  The way I would like it to work would be to have in the image's recipe a different variable then IMAGE_INSTALL which would serve the same purpose maybe DEVAPI_INSTALL and would go through those package only and call a task such as "do_build_devdoc" and maybe "do_install_devdoc", then packaging it into a FILES_*-devdoc set of instruction so that I may packages files at the end containing those docs.

  The image would then install those documentation in the sysroot under some folder, maybe /usr/share/devdoc/<packagename>/ and potentially create a tarball of this documentation.

   Anyway, let me know if something similar pre-exists or if such a project has been started somehow please, as I would like to contribute/participate.

--
Yannick Koehler

Re: Generating Package/Image Developer Documentation

[Alexander Kanavin]

On 11/20/2017 09:53 PM, Koehler, Yannick wrote:
>    The image would then install those documentation in the sysroot under some folder, maybe /usr/share/devdoc/<packagename>/ and potentially create a tarball of this documentation.
> 
>     Anyway, let me know if something similar pre-exists or if such a project has been started somehow please, as I would like to contribute/participate.


Yes. Add "api-documentation" to DISTRO_FEATURES and you will get 
manpages and gtk-doc based documentation generated, packaged and added 
to SDKs. It will slow down the build significantly, so use with care.

I considered adding doxygen support as well, but generating and 
installing that needs to be hand-crafted for each recipe, and so it 
wasn't done. You are welcome to work on that, subject to 
api-documentation being enabled. I have a recipe for doxygen itself here:

http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=akanavin/enable-doxygen

Alex

Re: Generating Package/Image Developer Documentation

[Koehler, Yannick]

Thanks,

I am using Yocto 1.9/2.0 and a quick grep doesn't seems to indicate support for this DISTRO_FEATURE.

In my case, the package I care about all use CMake and have a similar structure

	/CMakeLists.txt # A dev doc target exists here
	/doc
		/CMakeLists.txt
		/Doxyfile.in

As such, I can have a single script to handle them, using "make devdoc".  I may not be able to push this upstream but I'll see what I can do.

Maybe the "target" to build doc could be per-recipe.  

--
Yannick Koehler

-----Message d'origine-----
De : Alexander Kanavin [mailto:alexander.kanavin@linux.intel.com] 
Envoyé : 21 novembre 2017 04:56
À : Koehler, Yannick <yannick.koehler@hpe.com>; yocto@yoctoproject.org
Objet : Re: [yocto] Generating Package/Image Developer Documentation

On 11/20/2017 09:53 PM, Koehler, Yannick wrote:
>    The image would then install those documentation in the sysroot under some folder, maybe /usr/share/devdoc/<packagename>/ and potentially create a tarball of this documentation.
> 
>     Anyway, let me know if something similar pre-exists or if such a project has been started somehow please, as I would like to contribute/participate.


Yes. Add "api-documentation" to DISTRO_FEATURES and you will get manpages and gtk-doc based documentation generated, packaged and added to SDKs. It will slow down the build significantly, so use with care.

I considered adding doxygen support as well, but generating and installing that needs to be hand-crafted for each recipe, and so it wasn't done. You are welcome to work on that, subject to api-documentation being enabled. I have a recipe for doxygen itself here:

http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=akanavin/enable-doxygen

Alex

Re: Generating Package/Image Developer Documentation

[Alexander Kanavin]

On 11/22/2017 06:16 PM, Koehler, Yannick wrote:

> I am using Yocto 1.9/2.0 and a quick grep doesn't seems to indicate support for this DISTRO_FEATURE.

This was added about a year ago and Yocto 1.9 is a lot older. If you 
want to submit your work upstream, you have to rebase it to the master 
branch first.

Alex