Updates to documentation in prep for 0.5
This commit is contained in:
		| @@ -2,35 +2,62 @@ | ||||
| MongoEngine User Documentation | ||||
| ============================== | ||||
|  | ||||
| MongoEngine is an Object-Document Mapper, written in Python for working with | ||||
| **MongoEngine** is an Object-Document Mapper, written in Python for working with | ||||
| MongoDB. To install it, simply run | ||||
|  | ||||
| .. code-block:: console | ||||
|  | ||||
|     # pip install -U mongoengine | ||||
|  | ||||
| The source is available on `GitHub <http://github.com/hmarr/mongoengine>`_. | ||||
| :doc:`tutorial` | ||||
|   Start here for a quick overview. | ||||
|  | ||||
| :doc:`guide/index` | ||||
|   The Full guide to MongoEngine | ||||
|  | ||||
| :doc:`apireference` | ||||
|   The complete API documentation. | ||||
|  | ||||
| :doc:`django` | ||||
|   Using MongoEngine and Django | ||||
|  | ||||
| Community | ||||
| --------- | ||||
|  | ||||
| To get help with using MongoEngine, use the `MongoEngine Users mailing list | ||||
| <http://groups.google.com/group/mongoengine-users>`_ or come chat on the | ||||
| `#mongoengine IRC channel <irc://irc.freenode.net/mongoengine>`_. | ||||
|  | ||||
| If you are interested in contributing, join the developers' `mailing list | ||||
| Contributing | ||||
| ------------ | ||||
|  | ||||
| The source is available on `GitHub <http://github.com/hmarr/mongoengine>`_ and | ||||
| contributions are always encouraged. Contributions can be as simple as | ||||
| minor tweaks to this documentation. To contribute, fork the project on | ||||
| `GitHub <http://github.com/hmarr/mongoengine>`_ and send a | ||||
| pull request. | ||||
|  | ||||
| Also, you can join the developers' `mailing list | ||||
| <http://groups.google.com/group/mongoengine-dev>`_. | ||||
|  | ||||
| Changes | ||||
| ------- | ||||
| See the :doc:`changelog` for a full list of changes to MongoEngine. | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|    :hidden: | ||||
|  | ||||
|    tutorial | ||||
|    guide/index | ||||
|    apireference | ||||
|    django | ||||
|    changelog | ||||
|    upgrading | ||||
|    upgrade | ||||
|  | ||||
| Indices and tables | ||||
| ================== | ||||
| ------------------ | ||||
|  | ||||
| * :ref:`genindex` | ||||
| * :ref:`modindex` | ||||
| * :ref:`search` | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user