Create API documentation

[deni-zen]

Find the easiest/best way to generate API documentation for the library. Generate PHP HTML Documentor or whatever it is. Then see if you can find some feature of Github that allows me to create easy-to-use documentation pages.

• [x] I found the one I want to use (Apigen) but I need to now find a way to auto-generate the docs for each build (and each majorver)/minor version or whatever
• [x] Need to create a directory structure something like I outline below so that it's easy to find the latest docs for each version as well as latest in general. Also so that each version's API docs are archived.
• [ ] Write a bash script to generate newest version of docs, and then copy them to the correct location(s) in order to maintain the version tree like below - this is a good idea... do this some day...

/ apidocs
    /latest  
    /v0.x
        /latest
        /v0.1.x
            /latest
            /v0.1.1
            /v0.1.2
            /v0.1.3
            /v0.1.4
        /v0.2.x
            /latest
            /v0.2.1
            /v0.2.2
            /v0.3.3
            /v0.4.4
    /v1.x
        /latest
        /v1.1.x
            /latest
            /v1.1.1
            /v1.1.2
            /v1.1.3
            /v1.1.4
        /v1.2.x
            /latest
            /v1.2.1
            /v1.2.2
            /v1.3.3
            /v1.4.4

It would probably be better to make the URL like:

• /csvelte/apidocs/v0/1/1
• /csvelte/apidocs/v0/1/latest

Or something... figure it out.

This is the command I use to generate the docs:

$ cd /var/www/csvelte 
$ apigen generate -s ./src -d /var/www/gh-pages/csvelte/csvelte/apidocs/latest \
    --access-levels=public \
    --google-analytics=UA-83431108-1 \
    --google-cse-id=002645647446389662336:uolgqyfdbkq \
    --download \
    --template-theme=bootstrap \
    --title="CSVelte v0.1 API Documentation" \
    --tree

[deni-zen]

I generated some PHPDocumentor documentation on my macbook at /Users/luke/Sites/csvelte-pages/csvelte/phpdoc

[nozavroni]

Although I did generate docs for the current version and they are hosted on gh-pages, I still need to find a way to do this for each release automatically. Pushing this to v0.2 for now.

[nozavroni]

Well, it appears that it's finally time to move my API docs over to Sphinx. There is a bug in ApiGen that makes it impossible to use with CSVelte now that I am using namespaced functions. See https://github.com/apigen/apigen/issues/495 for more info on that.

It's for the best... it will be much easier to maintain my API docs when they're all within Sphinx and on one domain/URI. So make it happen with the Sphinx PHP API docs generator you found... there's already an issue for it somewhere I believe...

Well, unfortunately sphpdox uses the same library that causes the damn bug, so I'm just kinda screwed I guess.