Generate doxygen documentation after merge and publish it on https://doc.wikimedia.org and link to it from docs.wikiba.se and link to it from our other documentations.
See for how to automatically run and publish documentation: https://www.mediawiki.org/wiki/Continuous_integration/Documentation_generation
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Invalid | None | T108946 [Epic] Improve the development infrastructure | |||
| Resolved | Ladsgroup | T133028 [Story] autogenerated Wikibase documentation | |||
| Resolved | Ladsgroup | T66996 [Story] Automatically create Doxygen documentation of Wikibase PHP code |
http://docs.wikiba.se/ sounds good. Maybe a structure like
http://docs.wikiba.se/repo/0.5/php/
http://docs.wikiba.se/repo/0.5/js/
http://docs.wikiba.se/client/0.5/php/
http://docs.wikiba.se/client/0.5/js/
Not sure if the php/js separation is needed. Is Doxygen able to process both in a single documentation?
If this is done please create a redirect from http://wikidata-docs.wikimedia.de/ to the new location.
For reference, core doxygen docs are here:
https://doc.wikimedia.org/mediawiki-core/master/php/html/index.html
No JS in these docs though. This is shown on the sidebar on https://www.mediawiki.org/ as "Code docs".
The JS could be filtered with a second tool, like http://svn.berlios.de/wsvn/jsunit/trunk/jsunit/util/js2doxy.pl?op=file&rev=0&sc=0 described here http://jsunit.berlios.de/internal.html (assuming it is documented per Javadoc conventions).
Note that WB code has not yet implemented doc groups/modules (unlike core).
See http://www.stack.nl/~dimitri/doxygen/manual/grouping.html
May want to consider adding this rather than splitting up into separate doc builds.
See http://wbdoc.wmflabs.org/ for bundled Wikibase build documentation test.
Check http://wbdoc.wmflabs.org/doxygen.log for warnings.
Can you put it on https://doc.wikimedia.org with the other generated documentation? I think you create a make doc command and Jenkins runs it on check-in through the magic of Continuous integration. @hashar might be able to help.
There is currently a doxygen job for core. See also T94715. We probably need to create a new one for extensions.