From 2d2c57d2333a14ad948ccbbb269f9ea3f7f9a346 Mon Sep 17 00:00:00 2001 From: Ben Ramsey Date: Sun, 21 Jun 2015 19:52:46 -0500 Subject: [PATCH] Remove apigen.neon config --- .gitattributes | 1 - README.md | 8 +++++++- apigen.neon | 8 -------- 3 files changed, 7 insertions(+), 10 deletions(-) delete mode 100644 apigen.neon diff --git a/.gitattributes b/.gitattributes index 60c2a77..ddaab02 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,4 +4,3 @@ /tests export-ignore /phpunit.xml.dist export-ignore /phpcs.xml export-ignore -/apigen.neon export-ignore diff --git a/README.md b/README.md index 00d82ee..e5fb155 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,13 @@ Much inspiration for this library came from the [Java][javauuid] and The [latest class API documentation][apidocs] is available online. This project uses [ApiGen](http://apigen.org/) to generate this documentation. To -generate the documentation on your own, run `apigen` from the root of the project. +generate the documentation on your own, install ApiGen and run the following command +from the root of the project: + +``` +apigen generate --source="src" --destination="build/apidocs" --title="ramsey/uuid" --template-theme="bootstrap" --deprecated --todo +``` + This will generate documentation in the `build/apidocs/` folder. ## Requirements diff --git a/apigen.neon b/apigen.neon deleted file mode 100644 index f82ef61..0000000 --- a/apigen.neon +++ /dev/null @@ -1,8 +0,0 @@ -source: src/ -destination: build/apidocs -title: ramsey/uuid 3.0.x-dev -main: Ramsey -deprecated: true -templateTheme: bootstrap -todo: true -sourceCode: true