diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 01857b676..4c057af57 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,7 +2,7 @@ Contributing to PyMongo ======================= PyMongo has a large `community -`_ and +`_ and contributions are always encouraged. Contributions can be as simple as minor tweaks to the documentation. Please read these guidelines before sending a pull request. @@ -41,7 +41,7 @@ General Guidelines Documentation ------------- -To contribute to the `API documentation `_ +To contribute to the `API documentation `_ just make your changes to the inline documentation of the appropriate `source code `_ or `rst file `_ in a diff --git a/README.rst b/README.rst index decd4beac..792861251 100644 --- a/README.rst +++ b/README.rst @@ -204,8 +204,10 @@ Here's a basic example (for more see the *examples* section of the docs): Documentation ============= -You will need sphinx_ installed to generate the -documentation. Documentation can be generated by running **python +Documentation is available at [pymongo.readthedocs.io](https://pymongo.readthedocs.io/en/stable/). + +To build the documentation, you will need to install sphinx_. +Documentation can be generated by running **python setup.py doc**. Generated documentation can be found in the *doc/build/html/* directory. diff --git a/pymongo/topology.py b/pymongo/topology.py index 7f65a36df..233882bbc 100644 --- a/pymongo/topology.py +++ b/pymongo/topology.py @@ -155,7 +155,7 @@ class Topology(object): warnings.warn( "MongoClient opened before fork. Create MongoClient only " "after forking. See PyMongo's documentation for details: " - "http://api.mongodb.org/python/current/faq.html#" + "https://pymongo.readthedocs.io/en/stable/faq.html#" "is-pymongo-fork-safe") with self._lock: # Reset the session pool to avoid duplicate sessions in diff --git a/setup.py b/setup.py index e7e7f6e8f..8850e0e55 100755 --- a/setup.py +++ b/setup.py @@ -247,7 +247,7 @@ although they do result in significant speed improvements. Please see the installation docs for solutions to build issues: -http://api.mongodb.org/python/current/installation.html +https://pymongo.readthedocs.io/en/stable/installation.html Here are some hints for popular operating systems: @@ -269,7 +269,7 @@ PyMongo using pip. Modern versions of pip will install PyMongo from binary wheels available on pypi. If you must install from source read the documentation here: -https://api.mongodb.com/python/current/installation.html#installing-from-source-on-windows +https://pymongo.readthedocs.io/en/stable/installation.html#installing-from-source-on-windows If you are seeing this message on macOS / OSX please install PyMongo using pip. Modern versions of pip will install PyMongo from binary @@ -277,7 +277,7 @@ wheels available on pypi. If wheels are not available for your version of macOS / OSX, or you must install from source read the documentation here: -http://api.mongodb.org/python/current/installation.html#osx +https://pymongo.readthedocs.io/en/stable/installation.html#osx ******************************************************************** """