API documentation

Hey @yxdragon I noticed that there is some kind of API documentation on www.imagepy.org
Is it generated from the code automatically ?

I played a bit with Doxygen doc generator. It has a GUI and in a few click you get your html pages.
Any existing doc string will automatically be catched :slight_smile:
It would be easy to contribute to the doc then just by improving the docstrings of the source code :wink:

image

1 Like

Actually you can even host such API documentation directly on GitHub, by putting the generated html doc in a branch called gh-pages.
Here is the preview on my fork of the Imagepy repo.
Let me know @yxdragon, I could submit a pull request if you create such branch :wink:

1 Like