72 lines
2.4 KiB
ReStructuredText
72 lines
2.4 KiB
ReStructuredText
PyMongo |release| Documentation
|
|
===============================
|
|
|
|
.. note:: The PyMongo documentation has been migrated to the
|
|
`MongoDB Documentation site <https://www.mongodb.com/docs/languages/python/pymongo-driver/current>`_.
|
|
This site contains only the detailed changelog and API docs, while the
|
|
rest of the documentation appears on the MongoDB Documentation site.
|
|
|
|
Overview
|
|
--------
|
|
**PyMongo** is a Python distribution containing tools for working with
|
|
`MongoDB <https://www.mongodb.org>`_, and is the recommended way to
|
|
work with MongoDB from Python.
|
|
|
|
:doc:`api/index`
|
|
The complete API documentation, organized by module.
|
|
|
|
:doc:`changelog`
|
|
A full list of changes to PyMongo.
|
|
|
|
|
|
Getting Help
|
|
------------
|
|
If you're having trouble or have questions about PyMongo, ask your question on
|
|
one of the platforms listed on `Technical Support <https://www.mongodb.com/docs/manual/support/>`_.
|
|
You may also want to consider a
|
|
`commercial support subscription <https://support.mongodb.com/welcome>`_.
|
|
Once you get an answer, it'd be great if you could work it back into this
|
|
documentation and contribute!
|
|
|
|
Issues
|
|
------
|
|
All issues should be reported (and can be tracked / voted for /
|
|
commented on) at the main `MongoDB JIRA bug tracker
|
|
<https://jira.mongodb.org/browse/PYTHON>`_, in the "Python Driver"
|
|
project.
|
|
|
|
Feature Requests / Feedback
|
|
---------------------------
|
|
Use our `feedback engine <https://feedback.mongodb.com/?category=7548141816650747033>`_
|
|
to send us feature requests and general feedback about PyMongo.
|
|
|
|
Contributing
|
|
------------
|
|
**PyMongo** has a large :doc:`community <contributors>` and
|
|
contributions are always encouraged. Contributions can be as simple as
|
|
minor tweaks to this documentation. To contribute, fork the project on
|
|
`GitHub <https://github.com/mongodb/mongo-python-driver/>`_ and send a
|
|
pull request.
|
|
|
|
About This Documentation
|
|
------------------------
|
|
This documentation is generated using the `Sphinx
|
|
<https://www.sphinx-doc.org/en/master/>`_ documentation generator. The source files
|
|
for the documentation are located in the *doc/* directory of the
|
|
**PyMongo** distribution. See the PyMongo `contributing guide <https://github.com/mongodb/mongo-python-driver/blob/master/CONTRIBUTING.md>`_
|
|
for instructions on the building the docs from source.
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
api/index
|
|
changelog
|
|
contributors
|