Merge branch 'hotfix/bookdown'

Proper bookdown and mkdocs toolchains

Author: weierophinney

.gitignore

@@ -6,8 +6,9 @@
 .*.sw*
 .*.un~
 nbproject
-tmp/
 
+doc/html/
+tmp/
 clover.xml
 composer.lock
 coveralls-upload.json

README.md

@@ -9,6 +9,6 @@ code. While the current implementation is limited to generating PHP code, you
 can easily extend the base class in order to provide code generation for other
 tasks: JavaScript, configuration files, apache vhosts, etc.
 
-
 - File issues at https://github.com/zendframework/zend-code/issues
-- Documentation is at http://framework.zend.com/manual/current/en/index.html#zend-code
+- Documentation is at http://zend-code.rtfd.org
+- Migration documentation from v2 to v3 is at http://zend-code.rtfd.org/en/latest/book/migration/

doc/book/generator/bookdown.json

@@ -0,0 +1,8 @@
+{
+  "title": "zend-code Generator Component",
+  "content": [
+    {"Intro": "intro.md"},
+    {"Examples": "examples.md"},
+    {"Reference": "reference.md"}
+  ]
+}

doc/book/zend.code.generator.examples.md renamed to doc/book/generator/examples.md

@@ -1,6 +1,6 @@
-# Migrating from `Zend\Code` `2.*` to `3.0.0`
+# Migrating from zend-code v2 to v3
 
-### `string`, `int`, `float`, `bool` are no longer ignored
+## `string`, `int`, `float`, `bool` are no longer ignored
 
 In 2.x, a `Zend\Code\Generator\ParameterGenerator` with name `foo` and type 
 `string`, `int`, `float` or `bool` simply generated code `"$foo"`:
@@ -27,7 +27,7 @@ if (in_array($type, ['string', 'int', 'float', 'bool'])) {
 $generator->setType($type);
 ```
 
-### `Zend\Code\Reflection\ParameterReflection#getType()` changes
+## `Zend\Code\Reflection\ParameterReflection#getType()` changes
 
 PHP 7 introduced [`ReflectionParameter#getType()`](http://php.net/manual/en/reflectionparameter.gettype.php).
 
@@ -37,7 +37,7 @@ was renamed to `Zend\Code\Reflection\ParameterReflection#detectType()`.
 If you relied on `Zend\Code\Reflection\ParameterReflection#getType()`, you can
 simply replace the method calls in your code.
 
-### DocBlock types ignored by `Zend\Code\Generator\ParameterGenerator::fromReflection()`
+## DocBlock types ignored by `Zend\Code\Generator\ParameterGenerator::fromReflection()`
 
 As a direct consequence of the previous change, calls to 
 `Zend\Code\Generator\ParameterGenerator::fromReflection()` will not mirror the
@@ -73,7 +73,7 @@ That also means that reflecting scalar type hints from DocBlocks into the
 signature of a generated method may lead to fatal errors (due to signature
 mismatch) at runtime.
 
-### Type strings are validated
+## Type strings are validated
 
 If you attempt to generate type-hints for parameters or return types, those types are
 now validated before the code is generated.
@@ -94,7 +94,7 @@ $parameterGenerator->setType('\\'); // invalid (throws exception)
 ```
 
 
-### Generated type-hints are now prefixed by `"\"`
+## Generated type-hints are now prefixed by `"\"`
 
 Generated type-hints are now prefixed with the `NAMESPACE_SEPARATOR`,
 `"\"`.
@@ -116,14 +116,13 @@ In version 3.x, it produces `public function foo(\baz $bar) : \tab {}`.
 In order to avoid migration problems, be sure to always pass fully qualified class
 names to `Zend\Code\Generator\MethodGenerator` and `Zend\Code\Generator\ParameterGenerator`.
 
-
-### `Zend\Code\Generator\ParameterGenerator::$simple` was removed
+## `Zend\Code\Generator\ParameterGenerator::$simple` was removed
 
 If you extended `Zend\Code\Generator\ParameterGenerator`, be sure to check if you
 are accessing the protected static variable `$simple`: it was removed, and you should
 adapt your code by either copying it into your class or avoiding its usage.
 
-### `Zend\Code\Generator\ParameterGenerator::$type` has changed
+## `Zend\Code\Generator\ParameterGenerator::$type` has changed
 
 If you extended `Zend\Code\Generator\ParameterGenerator`, be sure to check if you
 are accessing the protected variable `$type`: its type has changed.

doc/book/zend.code.generator.introduction.md renamed to doc/book/generator/intro.md

@@ -1,10 +1,9 @@
 {
-    "title": "Zend\\Code",
-    "target": "html/",
-    "content": [
-        "book/zend.code.generator.introduction.md",
-        "book/zend.code.generator.reference.md",
-        "book/zend.code.generator.examples.md",
-        "book/zend.code.migrate.2.to.3.md"
-    ]
-}
+  "title": "zend-code: Tools for reflecting, scanning, and generating PHP code",
+  "content": [
+    {"Intro": "../README.md"},
+    "book/generator/bookdown.json",
+    {"Migration from v2 to v3": "book/migration.md"}
+  ],
+  "target": "./html"
+}

doc/book/zend.code.generator.reference.md renamed to doc/book/generator/reference.md

@@ -2,11 +2,9 @@ docs_dir: doc/book
 site_dir: doc/html
 pages:
     - index.md
-    - zend.code.generator.introduction.md
-    - zend.code.generator.reference.md
-    - zend.code.generator.examples.md
-    - zend.code.migrate.2.to.3.md
+    - { 'zend-code Generator Component': [{ Intro: generator/intro.md }, { Examples: generator/examples.md }, { Reference: generator/reference.md }] }
+    - { 'Migration from v2 to v3': migration.md }
 site_name: zend-code
-site_description: Zend\Code
+site_description: 'zend-code: Tools for reflecting, scanning, and generating PHP code'
 repo_url: 'https://github.com/zendframework/zend-code'
 copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'