WIP documentation

Author: Korbeil

AutoMapper/introduction.rst

@@ -0,0 +1,32 @@
+AutoMapper
+===========
+
+Jane JsonSchema is a library to generate models and serializers in PHP from a `JSON Schema`_ draft v4.
+
+Installation
+------------
+
+Add this library with composer as a ``dev`` dependency:
+
+.. code-block:: bash
+
+    composer require --dev jane-php/json-schema "^5.0"
+
+This library contains a lot of dependencies to be able to generate code which are not needed on runtime. However, the generated
+code depends on other libraries and a few classes that are available through the runtime package. It is highly recommended
+to add the runtime dependency as a requirement through composer:
+
+.. code-block:: bash
+
+    composer require jane-php/json-schema-runtime "^5.0"
+
+By default, generated code is not formatted, to make it compliant to PSR2 standard and others format norms, you can add the
+`PHP CS Fixer`_ library to your dev dependencies (and it makes it easier to debug!):
+
+.. code-block:: bash
+
+    composer require --dev friendsofphp/php-cs-fixer
+
+
+.. _`JSON Schema`: http://json-schema.org/
+.. _PHP CS Fixer: http://cs.sensiolabs.org/

OpenAPI/introduction.rst

@@ -1,4 +1,4 @@
-Json Schema
+OpenAPI
 ===========
 
 Jane OpenAPI is a library to generate, in PHP, an http client and its associated models and serializers from a `OpenAPI`_

Pipfile

@@ -0,0 +1,13 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+sphinx = "*"
+sphinx-rtd-theme = "*"
+
+[requires]
+python_version = "2.7"

Pipfile.lock

@@ -27,4 +27,4 @@ No class will be removed between minor versions, but there can be new classes ad
 Runtime Libraries
 -----------------
 
-JsonSchema Runtime and OpenAPI Runtime libraries have a standard BC Promise.
+JsonSchema Runtime and OpenAPI Runtime libraries have a standard BC Promise.

bc.rst

@@ -1,11 +1,12 @@
 Jane: Tools for generating PHP Code
 ===================================
 
-Jane regroups different tools that aim to generated high quality PHP
-code respecting common and advanced PSR.
+Jane is a set of libraries to generate Models & API Clients based on JsonSchema / OpenAPI specs
+by following high quality PHP code guidelines and respecting common & advanced PSR.
 
- * JsonSchema
- * OpenAPI
+ * :doc:`/JsonSchema/introduction`
+ * :doc:`/OpenAPI/introduction`
+ * :doc:`/AutoMapper/introduction`
 
 .. toctree::
    :hidden:
@@ -31,5 +32,10 @@ code respecting common and advanced PSR.
    Introduction <OpenAPI/introduction>
    Generating a Client <OpenAPI/generate>
    Using a generated client <OpenAPI/usage>
-   Asynchronous Client <OpenAPI/async>
    Extending the Client <OpenAPI/extending>
+
+.. toctree::
+   :hidden:
+   :caption: AutoMapper
+
+   Introduction <AutoMapper/introduction>

index.rst

@@ -1,10 +1,10 @@
 Internal
 ========
 
-This documentation describes how all Jane libraries work to generate the code. It is mainly oriented for people wanting
-to contribute to this library.
+This documentation describes how JsonSchema & OpenAPI Jane libraries work to generate the code.
+It is mainly oriented for people wanting to contribute to theses libraries.
 
-This library is based on 3 different steps:
+Theses libraries is based on 3 different steps:
 
 Guessing
 --------