File tree 4 files changed +10
-8
lines changed
4 files changed +10
-8
lines changed Original file line number Diff line number Diff line change @@ -2,7 +2,7 @@ Contributing to PyMongo
2
2
=======================
3
3
4
4
PyMongo has a large `community
5
- <http ://api.mongodb.org/python/current /contributors.html> `_ and
5
+ <https ://pymongo.readthedocs.io/en/stable /contributors.html> `_ and
6
6
contributions are always encouraged. Contributions can be as simple as
7
7
minor tweaks to the documentation. Please read these guidelines before
8
8
sending a pull request.
@@ -41,7 +41,7 @@ General Guidelines
41
41
Documentation
42
42
-------------
43
43
44
- To contribute to the `API documentation <http ://api.mongodb.org/python/current / >`_
44
+ To contribute to the `API documentation <https ://pymongo.readthedocs.io/en/stable / >`_
45
45
just make your changes to the inline documentation of the appropriate
46
46
`source code <https://github.com/mongodb/mongo-python-driver >`_ or `rst file
47
47
<https://github.com/mongodb/mongo-python-driver/tree/master/doc> `_ in a
Original file line number Diff line number Diff line change @@ -204,8 +204,10 @@ Here's a basic example (for more see the *examples* section of the docs):
204
204
Documentation
205
205
=============
206
206
207
- You will need sphinx _ installed to generate the
208
- documentation. Documentation can be generated by running **python
207
+ Documentation is available at [pymongo.readthedocs.io](https://pymongo.readthedocs.io/en/stable/).
208
+
209
+ To build the documentation, you will need to install sphinx _.
210
+ Documentation can be generated by running **python
209
211
setup.py doc **. Generated documentation can be found in the
210
212
*doc/build/html/ * directory.
211
213
Original file line number Diff line number Diff line change @@ -155,7 +155,7 @@ def open(self):
155
155
warnings .warn (
156
156
"MongoClient opened before fork. Create MongoClient only "
157
157
"after forking. See PyMongo's documentation for details: "
158
- "http ://api.mongodb.org/python/current /faq.html#"
158
+ "https ://pymongo.readthedocs.io/en/stable /faq.html#"
159
159
"is-pymongo-fork-safe" )
160
160
with self ._lock :
161
161
# Reset the session pool to avoid duplicate sessions in
Original file line number Diff line number Diff line change @@ -247,7 +247,7 @@ class custom_build_ext(build_ext):
247
247
248
248
Please see the installation docs for solutions to build issues:
249
249
250
- http ://api.mongodb.org/python/current /installation.html
250
+ https ://pymongo.readthedocs.io/en/stable /installation.html
251
251
252
252
Here are some hints for popular operating systems:
253
253
@@ -269,15 +269,15 @@ class custom_build_ext(build_ext):
269
269
from binary wheels available on pypi. If you must install from
270
270
source read the documentation here:
271
271
272
- https://api.mongodb.com/python/current /installation.html#installing-from-source-on-windows
272
+ https://pymongo.readthedocs.io/en/stable /installation.html#installing-from-source-on-windows
273
273
274
274
If you are seeing this message on macOS / OSX please install PyMongo
275
275
using pip. Modern versions of pip will install PyMongo from binary
276
276
wheels available on pypi. If wheels are not available for your version
277
277
of macOS / OSX, or you must install from source read the documentation
278
278
here:
279
279
280
- http ://api.mongodb.org/python/current /installation.html#osx
280
+ https ://pymongo.readthedocs.io/en/stable /installation.html#osx
281
281
********************************************************************
282
282
"""
283
283
You can’t perform that action at this time.
0 commit comments