New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add auto generated API docs using apigen with twitter-bootstrap template #2171
Conversation
I will review this later on today :)
…On Thu, Mar 16, 2017 at 8:28 AM Coveralls ***@***.***> wrote:
[image: Coverage Status] <https://coveralls.io/builds/10624444>
Coverage remained the same at 98.149% when pulling *b2de657
<b2de657>
on crtl:auto-generated-api-docs* into *91afa60
<91afa60>
on slimphp:3.x*.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#2171 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AD100lY7KIfNAVpsG_KYJZBUuRkhsq-tks5rmSsHgaJpZM4MfOqk>
.
|
@akrabat @codeguy @silentworks thought's on merging this into this repo? I was thinking about how it might be nice to have this on the website too. |
The only thing I care about is that it's automated |
I took a quick look, it does not appear to be automated. It would need to be run after we tag a new version. |
@akrabat its not, you would have to generate them manually. But its only one command (the one in my post) |
As per other issue: https://github.com/ApiGen/ApiGen/wiki/Generate-API-to-Github-pages-via-Travis |
Generally, I think the odds of remembering to do it manually are low |
Another thought. This needs to be on the Slim-Website repository as we're going to need this for 3.x and 4.x. Maybe this needs to be a bash/php script that is on Slim-Website that checks out the Slim repo, creates the api docs in the right place on the website and then deletes the Slim repo? |
Hi,
currently there is no further documentation besides the User Guide to get some insights into the framework so generated an API documentation with apigen using the twitter-bootstrap template.