Re: [Inkscape-devel] [Inkscape-docs] Adding extensions api docs

Hi all,
do we have someone with experience regarding doxygen?
Mois put some work into documenting the extension API (see inkscape-docs thread [1] for details and [2] for the open MR on GitLab). Some feedback would certainly be appreciated and it might be a good opportunity to recruit some help, whip our source documentation into shape and make it a bit more useful overall!
Thanks in advance, Eduard
[1] https://sourceforge.net/p/inkscape/mailman/inkscape-docs/thread/e9aeb332-159... [2] https://gitlab.com/inkscape/inkscape/merge_requests/123/
Am 14.11.2017 um 17:48 schrieb Mois:

Thank you Eduard.
I think there is an acceptable structure of the doxygen pages already (at least for now), but most of all I would like to add a CI step for building the documentation and potentially uploading it somewhere.
I already have the code for this, but didn't have luck with the gitlab docker runner locally, so it's untested. Does it work if I just push a separate branch? Alternatively, I see that a merge request has the build run on it, but would the .gitlab-ci.yml be taken from the fork?
Another issue is that doxygen is not installed on the CI runner hosts: https://gitlab.com/monomon/inkscape/-/jobs/40347524
The Dockerfile of the image needs to be changed too. I'll do this, but I've no clue how to coordinate it.
Regards, Mois
On 11/14/2017 09:26 PM, Eduard Braun wrote:

Should be fixed (I just added doxygen to the Dockerfile). I also just merged the doxygen MR now that I understood how to build it and could test it :)
Alternatively, I see that a merge request has the build run on it, but would the .gitlab-ci.yml be taken from the fork?
Yes, if it's in the MR diff.
The easiest thing to do would probably be to automatically get gitlab to upload stuff to http://inkscape.gitlab.io/inkscape/
Some time ago I put the scan-build result there, but it would make sense to have subfolders /doxygen/ and /scan-build/ to store different artifacts that are produced from the code. Would it be enough to rebuild the doc only every month (we can change the frequency) along with the scan-build report so that they are uploaded together ? (I put an attempt at https://gitlab.com/inkscape/inkscape/merge_requests/134 )

[Done]
http://inkscape.gitlab.io/inkscape/
Thanks, Mois !
participants (4)
-
Eduard Braun
-
Marc Jeanmougin
-
Maren Hachmann
-
Mois