Improved docs for generating documentation. Fixed #353

README.md

@@ -83,3 +83,21 @@ After developing, the full test suite can be evaluated by running:
 ```sh
 python setup.py test # Use --pytest-args="-v -s" for verbose mode
 ```
+
+
+### Documentation
+
+The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
+
+The documentation dependencies are installed by running:
+
+```sh
+cd docs
+pip install -r requirements.txt
+```
+
+Then to produce a HTML version of the documentation:
+
+```sh
+make html
+```

README.rst

@@ -1,37 +1,38 @@
-Please read `UPGRADE-v1.0.md`_ to learn how to upgrade to Graphene ``1.0``.
+Please read `UPGRADE-v1.0.md </UPGRADE-v1.0.md>`__ to learn how to
+upgrade to Graphene ``1.0``.
 
 --------------
 
-|Graphene Logo| `Graphene`_ |Build Status| |PyPI version| |Coverage Status|
+|Graphene Logo| `Graphene <http://graphene-python.org>`__ |Build Status| |PyPI version| |Coverage Status|
-===========================================================================
+=========================================================================================================
 
-`Graphene`_ is a Python library for building GraphQL schemas/types fast
+`Graphene <http://graphene-python.org>`__ is a Python library for
-and easily.
+building GraphQL schemas/types fast and easily.
 
 -  **Easy to use:** Graphene helps you use GraphQL in Python without
    effort.
 -  **Relay:** Graphene has builtin support for Relay
 -  **Data agnostic:** Graphene supports any kind of data source: SQL
-   (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe that
+   (Django, SQLAlchemy), NoSQL, custom Python objects, etc. We believe
-   by providing a complete API you could plug Graphene anywhere your
+   that by providing a complete API you could plug Graphene anywhere
-   data lives and make your data available through GraphQL.
+   your data lives and make your data available through GraphQL.
 
 Integrations
 ------------
 
 Graphene has multiple integrations with different frameworks:
 
-+---------------------+-------------------------------------+
++---------------------+----------------------------------------------------------------------------------------------+
 | integration         | Package                                                                                      |
-+=====================+=====================================+
++=====================+==============================================================================================+
-| Django              | `graphene-django`_                  |
+| Django              | `graphene-django <https://github.com/graphql-python/graphene-django/>`__                     |
-+---------------------+-------------------------------------+
++---------------------+----------------------------------------------------------------------------------------------+
-| SQLAlchemy          | `graphene-sqlalchemy`_              |
+| SQLAlchemy          | `graphene-sqlalchemy <https://github.com/graphql-python/graphene-sqlalchemy/>`__             |
-+---------------------+-------------------------------------+
++---------------------+----------------------------------------------------------------------------------------------+
-| Google App Engine   | `graphene-gae`_                     |
+| Google App Engine   | `graphene-gae <https://github.com/graphql-python/graphene-gae/>`__                           |
-+---------------------+-------------------------------------+
++---------------------+----------------------------------------------------------------------------------------------+
-| Peewee              | *In progress* (`Tracking Issue`_)   |
+| Peewee              | *In progress* (`Tracking Issue <https://github.com/graphql-python/graphene/issues/289>`__)   |
-+---------------------+-------------------------------------+
++---------------------+----------------------------------------------------------------------------------------------+
 
 Installation
 ------------
@@ -45,7 +46,8 @@ For instaling graphene, just run this command in your shell
 1.0 Upgrade Guide
 -----------------
 
-Please read `UPGRADE-v1.0.md`_ to learn how to upgrade.
+Please read `UPGRADE-v1.0.md </UPGRADE-v1.0.md>`__ to learn how to
+upgrade.
 
 Examples
 --------
@@ -74,10 +76,11 @@ Then Querying ``graphene.Schema`` is as simple as:
     result = schema.execute(query)
 
 If you want to learn even more, you can also check the following
-`examples`_:
+`examples <examples/>`__:
 
--  **Basic Schema**: `Starwars example`_
+-  **Basic Schema**: `Starwars example <examples/starwars>`__
--  **Relay Schema**: `Starwars Relay example`_
+-  **Relay Schema**: `Starwars Relay
+   example <examples/starwars_relay>`__
 
 Contributing
 ------------
@@ -94,15 +97,24 @@ After developing, the full test suite can be evaluated by running:
 
     python setup.py test # Use --pytest-args="-v -s" for verbose mode
 
-.. _UPGRADE-v1.0.md: /UPGRADE-v1.0.md
+Documentation
-.. _Graphene: http://graphene-python.org
+~~~~~~~~~~~~~
-.. _graphene-django: https://github.com/graphql-python/graphene-django/
+
-.. _graphene-sqlalchemy: https://github.com/graphql-python/graphene-sqlalchemy/
+The documentation is generated using the excellent
-.. _graphene-gae: https://github.com/graphql-python/graphene-gae/
+`Sphinx <http://www.sphinx-doc.org/>`__ and a custom theme.
-.. _Tracking Issue: https://github.com/graphql-python/graphene/issues/289
+
-.. _examples: examples/
+The documentation dependencies are installed by running:
-.. _Starwars example: examples/starwars
+
-.. _Starwars Relay example: examples/starwars_relay
+.. code:: sh
+
+    cd docs
+    pip install -r requirements.txt
+
+Then to produce a HTML version of the documentation:
+
+.. code:: sh
+
+    make html
 
 .. |Graphene Logo| image:: http://graphene-python.org/favicon.png
 .. |Build Status| image:: https://travis-ci.org/graphql-python/graphene.svg?branch=master