gbv/jskos-php

Publish code documentation in a more beautiful form

Closed this issue · 2 comments

Code documentation can currently be generated with Doxygen an can be published at GitHub pages. The generated HTML could just be pushed to GitHub pages like described here but Doxygen default output is ugly. A possibly nicer place to host documentation is https://readthedocs.org/ which is based on Sphinx. Doxygen can generate XML to be imported into Sphinx by Breathe.

The API documentation can now be published in the gh-pages branch but still needs several manual steps. A composer script could be implemented in PHP to make sure each release gets documented properly.

removed the documentation because of complexity