pub/mongoengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More doc updates

Browse Source
This commit is contained in:
Ross Lawley 2013-04-23 20:49:22 +00:00
parent 8a7b619b77
commit 5271f3b4a0
2 changed files with 28 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guide/installing.rst
View File

@ -22,10 +22,10 @@ Alternatively, if you don't have setuptools installed, `download it from PyPi
$ python setup.py install $ python setup.py install
To use the bleeding-edge version of MongoEngine, you can get the source from To use the bleeding-edge version of MongoEngine, you can get the source from
`GitHub <http://github.com/hmarr/mongoengine/>`_ and install it as above: `GitHub <http://github.com/mongoengine/mongoengine/>`_ and install it as above:
.. code-block:: console .. code-block:: console
$ git clone git://github.com/hmarr/mongoengine $ git clone git://github.com/mongoengine/mongoengine
$ cd mongoengine $ cd mongoengine
$ python setup.py install $ python setup.py install

45
docs/index.rst
View File

@ -10,13 +10,15 @@ MongoDB. To install it, simply run
$ pip install -U mongoengine $ pip install -U mongoengine
:doc:`tutorial` :doc:`tutorial`
Start here for a quick overview. A quick tutorial building a tumblelog to get you up and running with
MongoEngine.
:doc:`guide/index` :doc:`guide/index`
The Full guide to MongoEngine The Full guide to MongoEngine - from modeling documents to storing files,
from querying for data to firing signals and *everything* between.
:doc:`apireference` :doc:`apireference`
The complete API documentation. The complete API documentation --- the innards of documents, querysets and fields.
:doc:`upgrade` :doc:`upgrade`
How to upgrade MongoEngine. How to upgrade MongoEngine.
@ -28,35 +30,40 @@ Community
--------- ---------
To get help with using MongoEngine, use the `MongoEngine Users mailing list To get help with using MongoEngine, use the `MongoEngine Users mailing list
<http://groups.google.com/group/mongoengine-users>`_ or come chat on the <http://groups.google.com/group/mongoengine-users>`_ or the ever popular
`#mongoengine IRC channel <irc://irc.freenode.net/mongoengine>`_. `stackoverflow <http://www.stackoverflow.com>`_.
Contributing Contributing
------------ ------------
The source is available on `GitHub <http://github.com/MongoEngine/mongoengine>`_ and **Yes please!** We are always looking for contributions, additions and improvements.
contributions are always encouraged. Contributions can be as simple as
minor tweaks to this documentation. To contribute, fork the project on The source is available on `GitHub <http://github.com/MongoEngine/mongoengine>`_
and contributions are always encouraged. Contributions can be as simple as
minor tweaks to this documentation, the website or the core.
To contribute, fork the project on
`GitHub <http://github.com/MongoEngine/mongoengine>`_ and send a `GitHub <http://github.com/MongoEngine/mongoengine>`_ and send a
pull request. pull request.
Also, you can join the developers' `mailing list
<http://groups.google.com/group/mongoengine-dev>`_.
Changes Changes
------- -------
See the :doc:`changelog` for a full list of changes to MongoEngine and See the :doc:`changelog` for a full list of changes to MongoEngine and
:doc:`upgrade` for upgrade information. :doc:`upgrade` for upgrade information.
.. toctree:: .. note:: Always read and test the `upgrade <upgrade>`_ documentation before
:hidden: putting updates live in production **;)**
tutorial .. toctree::
guide/index :hidden:
apireference
django tutorial
changelog guide/index
upgrade apireference
django
changelog
upgrade
Indices and tables Indices and tables
------------------ ------------------