Apigen Github Service

[beberlei]

It would be really awesome if you would provide a simple github service that builds the docs based on commit hook. Checking for an apigen.ini or something. What do you think? :)

[mavimo]

Using apigen.neon will be better ;)

[fprochazka]

There is something beeing created by @juzna, you can help it, or build on it :)

http://apigen.juzna.cz/

[juzna]

Yep, that's a very simple service, created quickly in two evenings. Please fork and send PRs, or provide ideas in issues on GitHub.

I've been working on some improvements, but they're not yet published because of lack of my time.

[Andrewsville]

Well, we (@kukulich and myself) have been preparing a service that would create a project documentation either automatically (via a service hook) or on demand. Unfortunately because of lack of our time the development didn't move for the last couple of months :(

[juzna]

@Andrewsville do you have something to show? Perhaps a more agile way would be better - to release a very simple version quickly and add features over time. But users would be able to use at least some basic features.

And perhaps community would also help. I received 3 pull requests almost immediately after the release ;)

[fprochazka]

Mainly guys, you have to cooperate. There is no need for two concurrent services :)

[Andrewsville]

I believe that @kukulich was speaking (or emailing) with @juzna and the result was that the two project aren't competing because their target is something else and they can easilly coexist. I hope we will resurrect it when we find some time :)

[Andrewsville]

Yeah and two things: I am against anything "agile" (for me it is a synonym of "half working piece of crap") and with @kukulich we have agreed that the project won't be open source.

[kukulich]

It's a little difficult to find some time for ApiGen with three months old baby :)

[triplepoint]

For what it's worth, there's http://gitapidoc.com/, maintained by https://github.com/xqus . As an example, he uses it to provide API documentation for the phpseclib project http://gitapidoc.com/api/phpsec/phpSec/master/ .

[TomasVotruba]

Similar working service http://apigenerator.org/

This is actually the greatest issue and I'd like to know opinions about this. In past ApiGen supported 3 diffs ways to use it. It is nice, but it caused project to die. I'd like to avoid to use only the most used one.

My question is, how to provide API generation?

1. composer
2. composer --global
3. phar
4. github service hook - best so far http://apigenerator.org/
5. public hosting - best so far http://apigen.juzna.cz/

Personally, I'd like to use service hook with public hosting (4+5) and maybe PHAR (3) for private projects.

What about you?

[hrach]

4, 5 are irrelevant for your sourcecode, it shouldn't force any decisions. Personally I prefer composer, 1, 2 are the same, I wouldn't bother with 3.

[fprochazka]

1. and 2) are The Standard, and should be the main way to use it
2. can be pretty much automated, but I'd make it a very low priority
   4, 5) are cool, but also not a priority I'd say