Skip to content

Commit df24ad9

Browse files
mongoKartjordan-smith721
mongoKart
and
jordan-smith721
authored
DOCSP-37014 - Index (#4)
Co-authored-by: Jordan Smith <[email protected]>
1 parent 312de08 commit df24ad9

File tree

9 files changed

+86
-70
lines changed

9 files changed

+86
-70
lines changed

‎source/faq.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. uses faq.rst, python3.rst
22

3+
.. _pymongo-faq:
4+
35
Frequently Asked Questions
46
==========================
57

‎source/fundamentals.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. _pymongo-fundamentals:
2+
3+
============
4+
Fundamentals
5+
============

‎source/index.txt‎

Lines changed: 63 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
.. uses index.rst
22

3-
PyMongo Documentation
4-
=====================
3+
.. _pymongo-index:
4+
5+
MongoDB PyMongo Documentation
6+
=============================
7+
8+
.. facet::
9+
:name: programming_language
10+
:values: python
11+
12+
.. meta::
13+
:keywords: home
14+
15+
.. toctree::
16+
17+
/previous-versions
18+
/quick-start
19+
/whats-new
20+
/fundamentals
21+
/tools
22+
API Documentation <{+api-root+}>
23+
/faq
24+
/troubleshooting
25+
/upgrade
526

627
Overview
728
--------
@@ -10,54 +31,59 @@ Overview
1031
work with MongoDB from Python. This documentation attempts to explain
1132
everything you need to know to use **PyMongo**.
1233

13-
.. todo:: a list of PyMongo's features
34+
Previous Versions
35+
-----------------
36+
37+
For documentation on versions of the driver v4.6.x and earlier, see the :ref:`pymongo-previous-versions` section.
1438

15-
.. :doc:`installation`
16-
Instructions on how to get the distribution.
39+
Quick Start
40+
-----------
1741

18-
.. :doc:`tutorial`
19-
Start here for a quick overview.
42+
Learn how to establish a connection to MongoDB and begin
43+
working with data in the :ref:`pymongo-quickstart` section.
2044

21-
.. :doc:`examples/index`
22-
Examples of how to perform specific tasks.
45+
What's New
46+
----------
2347

24-
.. :doc:`atlas`
25-
Using PyMongo with MongoDB Atlas.
48+
For a list of new features and changes in each version, see the :ref:`What's New <pymongo-whats-new>`
49+
section.
2650

27-
.. :doc:`examples/tls`
28-
Using PyMongo with TLS / SSL.
51+
Fundamentals
52+
------------
2953

30-
.. :doc:`examples/encryption`
31-
Using PyMongo with In-Use Encryption.
54+
For detailed information on key concepts of using the {+driver-short+}, see
55+
:ref:`pymongo-fundamentals`.
3256

33-
.. :doc:`examples/type_hints`
34-
Using PyMongo with type hints.
57+
Tools
58+
-----
59+
For a list of Python tools and libraries that have been written for
60+
MongoDB, see the :ref:`pymongo-tools` section.
3561

36-
.. :doc:`faq`
37-
Some questions that come up often.
62+
API Documentation
63+
-----------------
3864

39-
.. :doc:`migrate-to-pymongo4`
40-
A PyMongo 3.x to 4.x migration guide.
65+
For detailed information about types and methods in {+driver-short+}, see
66+
the `{+driver-short+} API documentation
67+
<{+api-root+}>`__.
4168

42-
.. :doc:`python3`
43-
Frequently asked questions about python 3 support.
69+
FAQ
70+
---
4471

45-
.. :doc:`compatibility-policy`
46-
Explanation of deprecations, and how to keep pace with changes in PyMongo's
47-
API.
72+
For answers to commonly asked questions about {+driver-short+}, see the :ref:`pymongo-faq`
73+
section.
4874

49-
.. :doc:`api/index`
50-
The complete API documentation, organized by module.
75+
Troubleshooting
76+
---------------
5177

52-
.. :doc:`tools`
53-
A listing of Python tools and libraries that have been written for
54-
MongoDB.
78+
For solutions to issues you might encounter when using the driver,
79+
see the :ref:`pymongo-troubleshooting` section.
5580

56-
.. :doc:`developer/index`
57-
Developer guide for contributors to PyMongo.
81+
Upgrade Driver Versions
82+
-----------------------
5883

59-
.. :doc:`common-issues`
60-
Common issues encountered when using PyMongo.
84+
Learn what changes you might need to make to your application to upgrade
85+
driver versions in the :ref:`Upgrade Driver Versions <pymongo-upgrade>`
86+
section.
6187

6288
Getting Help
6389
------------
@@ -82,39 +108,8 @@ to send us feature requests and general feedback about PyMongo.
82108

83109
Contributing
84110
------------
85-
.. **PyMongo** has a large :doc:`community <contributors>` and
86-
111+
**PyMongo** has a large community and
87112
contributions are always encouraged. Contributions can be as simple as
88113
minor tweaks to this documentation. To contribute, fork the project on
89114
`GitHub <http://github.com/mongodb/mongo-python-driver/>`_ and send a
90-
pull request.
91-
92-
Changes
93-
-------
94-
.. See the :doc:`changelog` for a full list of changes to PyMongo.
95-
96-
For older versions of the documentation please see the
97-
`archive list <http://api.mongodb.org/python/>`_.
98-
99-
About This Documentation
100-
------------------------
101-
This documentation is generated using the `Sphinx
102-
<https://www.sphinx-doc.org/en/master/>`_ documentation generator. The source files
103-
for the documentation are located in the *doc/* directory of the
104-
**PyMongo** distribution. To generate the docs locally run the
105-
following command from the root directory of the **PyMongo** source:
106-
107-
.. code-block:: bash
108-
109-
$ pip install tox
110-
$ tox -m doc
111-
112-
Indices and tables
113-
------------------
114-
115-
.. * :ref:`genindex`
116-
.. * :ref:`modindex`
117-
.. * :ref:`search`
118-
119-
.. toctree::
120-
:hidden:
115+
pull request.

‎source/previous-versions.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. _pymongo-previous-versions:
2+
3+
=================
4+
Previous Versions
5+
=================

‎source/quick-start.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.. _pymongo-quickstart:
21
.. uses installation.rst, atlas.rst
32
.. uses tutorial.rst
43

4+
.. _pymongo-quickstart:
5+
56
Quick Start
67
===========
78

‎source/tools/tools.txt‎ renamed to ‎source/tools.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. uses tools.rst
22

3+
.. _pymongo-tools:
4+
35
Tools
46
=====
57
Many tools have been written for working with **PyMongo**. If you know

‎source/troubleshooting.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. uses common-issues.rst
22

3+
.. _pymongo-troubleshooting:
4+
35
Troubleshooting
46
===============
57

‎source/upgrade.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
.. uses compatibility-policy.rst
22
.. uses migrate-to-pymongo4.rst
33

4-
Compatibility Policy
4+
.. _pymongo-upgrade:
5+
6+
Upgrade Driver Versions
57
====================
68

79
Semantic Versioning

‎source/whats-new.txt‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. uses changelog.rst
22

3+
.. _pymongo-whats-new:
4+
35
What's New
46
==========
57

0 commit comments

Comments
 (0)