Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Include API documentation in Read the Docs #43

Open
nterhoeven opened this issue Jul 19, 2016 · 2 comments
Open

Include API documentation in Read the Docs #43

nterhoeven opened this issue Jul 19, 2016 · 2 comments

Comments

@nterhoeven
Copy link

Since my last feature-request was closed, because it is already possible by using the API, I tried to find a documentation for it. I found these html files which seem to be an API documentation.

It would be nice to include this in an API-section in the Read the Docs manual pages. This would make it much easier for users to find and use the Tbro API.

@iimog iimog added this to the v1.1.0 milestone Jul 20, 2016
@iimog iimog self-assigned this Jul 20, 2016
@iimog
Copy link
Member

iimog commented Jul 20, 2016

This is a reasonable request. I will work on that as soon as my schedule permits. For the time being you can use the auto generated API documentation via apigen:
https://tbroteam.github.io/TBro/doc/apigen/

This is not perfect but I hope it helps you getting started.

@nterhoeven
Copy link
Author

cool, thank you :-)

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

No branches or pull requests

2 participants