Merge pull request #1 from erikdubbelboer/docs

Added doc generation

Author: erikdubbelboer

README.md

@@ -0,0 +1,10 @@
+
+PHP Atomx Api
+=============
+
+Interface for the atomx rest api.
+
+For more information read the full [documentation online](https://www.atomx.com/atomx-api-php/),
+report bugs in [github](https://github.com/atomx/atomx-api-php>),
+or see the [atomx wiki](https://wiki.atomx.com/api)
+

doc/.gitignore

@@ -0,0 +1,3 @@
+sami.phar
+build/
+cache/

doc/Makefile

@@ -0,0 +1,10 @@
+
+generate:
+	php sami.phar update config.php
+
+deploy:
+	rsync -avr --delete build/* /var/www/www.atomx.com/public/atomx-api-php/
+	cp index.php /var/www/www.atomx.com/public/atomx-api-php/
+
+.PHONY: build install
+

doc/README.md

@@ -0,0 +1,14 @@
+
+We use [Sami](https://github.com/FriendsOfPHP/Sami) to generate the documentation.
+
+To generate:
+```bash
+$ cd doc
+$ make
+```
+
+To deploy the generated documentation:
+```
+$ make deploy
+```
+

doc/config.php

@@ -0,0 +1,27 @@
+<?php
+
+use Sami\Sami;
+use Sami\RemoteRepository\GitHubRemoteRepository;
+use Sami\Version\GitVersionCollection;
+use Symfony\Component\Finder\Finder;
+
+$iterator = Finder::create()
+    ->files()
+    ->name('*.php')
+    ->in($dir = __DIR__.'/../Atomx')
+;
+
+$versions = GitVersionCollection::create($dir)
+    ->add('master', 'master branch')
+;
+
+return new Sami($iterator, array(
+    'theme'                => 'default',
+    'versions'             => $versions,
+    'title'                => 'Atomx API',
+    'build_dir'            => __DIR__.'/build/%version%',
+    'cache_dir'            => __DIR__.'/cache/%version%',
+    'remote_repository'    => new GitHubRemoteRepository('atomx/atomx-api-php', dirname($dir)),
+    'default_opened_level' => 2,
+));
+

doc/index.php

@@ -0,0 +1,4 @@
+<?php
+
+header('Location: https://www.atomx.com/atomx-api-php/master/index.html');
+