Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

crtl
Copy link

@crtl crtl commented Mar 16, 2017

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.

apigen generate --source Slim --destination docs --template-theme bootstrap

@coveralls
Copy link

Coverage Status

Coverage remained the same at 98.149% when pulling b2de657 on crtl:auto-generated-api-docs into 91afa60 on slimphp:3.x.

@geggleto
Copy link
Member

geggleto commented Mar 16, 2017 via email

@tflight
Copy link
Contributor

tflight commented Mar 16, 2017

@crtl have you seen #1617 ?

@geggleto
Copy link
Member

@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.

@akrabat
Copy link
Member

akrabat commented Mar 16, 2017

The only thing I care about is that it's automated

@geggleto
Copy link
Member

I took a quick look, it does not appear to be automated. It would need to be run after we tag a new version.

@crtl
Copy link
Author

crtl commented Mar 16, 2017

@akrabat its not, you would have to generate them manually. But its only one command (the one in my post)

@akrabat
Copy link
Member

akrabat commented Mar 16, 2017

As per other issue: https://github.com/ApiGen/ApiGen/wiki/Generate-API-to-Github-pages-via-Travis

@akrabat
Copy link
Member

akrabat commented Mar 16, 2017

Generally, I think the odds of remembering to do it manually are low

@akrabat
Copy link
Member

akrabat commented Mar 18, 2017

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?

@akrabat akrabat closed this Mar 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants