Add rosdoc generation for workspace
jihoonl opened this issue · comments
generates documents for all packages in the workspace and store in one directory.
Option1. yujin_make argument
yujin_make -d or --doc
Option2. independent script for doc generation
yujin_doc_make
@stonier
What would be the nice way configuring destination directory for docs?
Is there a way of setting this in config.cmake?
Well. Seems option2 is right way to go.
ros build farm generates doc independently from source. Also it is lighter
The following pull request is first draft.
It generates doc directory and stores all generated docs. Also creates index.html which allows to browse all package docs.
Future Implementation
- changing output directory
- threading
I like yujin_make --doc, since I suspect that will eliminate a bit of redundant code. But mostly just personal preference. yujin_make_doc is more consistent than yujin_doc_make as well - fits with the other names.
What would be the nice way configuring destination directory for docs?
Is there a way of setting this in config.cmake?
Haven't checked what you set as a default, but is devel/share/doc a good default? It'd get appropriately cleaned with a yujin_make --pre-clean. You could add something to yujin_make --install to install the folder if it exists as well.
And yes - using a config.cmake variable would be good if we actually want to install it elsewhere. You could even add the variable along with default to the template config.cmake.
I couldn't choose between yujin_make_doc and yujin_make --doc option. yujin_make --doc option is fine too.
I will add two options on yujin_make, --doc-only and --doc. One to generate doc only and one to use together with other options.
I think keeping --install and --doc separate is better. They can be used together but not always. It would be painful if I have to generate documents every time I install.
The default directory is doc.
pull request has been updated to use yujin_make -d
cmake configuration for doc destination may be introduced later.
Has this been released already?
This has been released.
True. Forgot this is installed via pip.