ReadTheDocs is a site that can build documentation and serve it online after every commit to a repository. We used to have something similar, but it ceased to work at some point.
It looks like it's fairly simple to mate Doxygen with ReadTheDocs (which uses the Sphinx documentation system) using a project called Breathe. http://breathe.readthedocs.org/en/latest/
I'll try to set this up for lib2geom tomorrow and report on the results.
Best regards, Krzysztof
2016-02-07 7:34 GMT+01:00 Krzysztof Kosiński <tweenk.pl@...400...>:
ReadTheDocs is a site that can build documentation and serve it online after every commit to a repository. We used to have something similar, but it ceased to work at some point.
I think it was set up on Jenkins as well but as you said in another email,
our Jenkins instance is not working properly (disk space available?).
It looks like it's fairly simple to mate Doxygen with ReadTheDocs (which uses the Sphinx documentation system) using a project called Breathe. http://breathe.readthedocs.org/en/latest/
I'll try to set this up for lib2geom tomorrow and report on the results.
Best regards, Krzysztof
ReadTheDocs is great; I haven't tried breathe.
Regards
2016-02-06 22:34 GMT-08:00 Krzysztof Kosiński <tweenk.pl@...400...>:
ReadTheDocs is a site that can build documentation and serve it online after every commit to a repository. We used to have something similar, but it ceased to work at some point.
It looks like it's fairly simple to mate Doxygen with ReadTheDocs (which uses the Sphinx documentation system) using a project called Breathe. http://breathe.readthedocs.org/en/latest/
I'll try to set this up for lib2geom tomorrow and report on the results.
Obviously that "tomorrow" didn't happen, but after reading about Breathe it seems that this is a rather brittle solution and not everything is supported. In particular, Doxygen member groups are unsupported, and I use them fairly often in 2Geom docs. It will be a lot less annoying to just push the Doxygen docs to a static pages service such as gh-pages or GitLab Pages from the continuous build system.
Best regards, Krzysztof
2016-02-24 7:30 GMT+01:00 Krzysztof Kosiński <tweenk.pl@...400...>:
2016-02-06 22:34 GMT-08:00 Krzysztof Kosiński <tweenk.pl@...400...>:
ReadTheDocs is a site that can build documentation and serve it online after every commit to a repository. We used to have something similar, but it ceased to work at some point.
It looks like it's fairly simple to mate Doxygen with ReadTheDocs (which uses the Sphinx documentation system) using a project called Breathe. http://breathe.readthedocs.org/en/latest/
I'll try to set this up for lib2geom tomorrow and report on the results.
Obviously that "tomorrow" didn't happen, but after reading about Breathe it seems that this is a rather brittle solution and not everything is supported. In particular, Doxygen member groups are unsupported, and I use them fairly often in 2Geom docs. It will be a lot less annoying to just push the Doxygen docs to a static pages service such as gh-pages or GitLab Pages from the continuous build system.
Best regards, Krzysztof
Yea, that sounds like a good solution.
participants (2)
-
Christoffer Holmstedt -
Krzysztof Kosiński