diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b75713638..6028fcab6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -46,5 +46,5 @@ just make your changes to the inline documentation of the appropriate `source code `_ or `rst file `_ in a branch and submit a `pull request `_. -You might also use the github `Edit `_ +You might also use the GitHub `Edit `_ button. diff --git a/README.rst b/README.rst index f2533aa09..43ba301e6 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ ======= PyMongo ======= -:Info: See `the mongo site `_ for more information. See `github `_ for the latest source. +:Info: See `the mongo site `_ for more information. See `GitHub `_ for the latest source. :Author: Mike Dirolf :Maintainer: Bernie Hackett diff --git a/doc/index.rst b/doc/index.rst index 109107113..051b68d1a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -64,7 +64,7 @@ Contributing **PyMongo** has a large :doc:`community ` and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation. To contribute, fork the project on -`github `_ and send a +`GitHub `_ and send a pull request. Changes diff --git a/doc/installation.rst b/doc/installation.rst index 14867f082..c8e4ba602 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -90,7 +90,7 @@ Installing from source If you'd rather install directly from the source (i.e. to stay on the bleeding edge), install the C extension dependencies then check out the -latest source from github and install the driver from the resulting tree:: +latest source from GitHub and install the driver from the resulting tree:: $ git clone git://github.com/mongodb/mongo-python-driver.git pymongo $ cd pymongo/ @@ -243,7 +243,7 @@ Installing a beta or release candidate MongoDB, Inc. may occasionally tag a beta or release candidate for testing by the community before final release. These releases will not be uploaded to pypi but can be found on the -`github tags page `_. +`GitHub tags page `_. They can be installed by passing the full URL for the tag to pip:: $ python -m pip install https://github.com/mongodb/mongo-python-driver/archive/3.6rc0.tar.gz diff --git a/doc/tools.rst b/doc/tools.rst index 056623557..9633bdc19 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -45,7 +45,7 @@ Humongolus you to create models/schemas with robust validation. It attempts to be as pythonic as possible and exposes the pymongo cursor objects whenever possible. The code is available for download - `at github `_. Tutorials and usage + `at GitHub `_. Tutorials and usage examples are also available at GitHub. Ming @@ -61,7 +61,7 @@ MongoEngine `MongoEngine `_ is another ORM-like layer on top of PyMongo. It allows you to define schemas for documents and query collections using syntax inspired by the Django - ORM. The code is available on `github + ORM. The code is available on `GitHub `_; for more information, see the `tutorial `_. @@ -70,14 +70,14 @@ MotorEngine MongoEngine to Motor, for asynchronous access with Tornado. It implements the same modeling APIs to be data-portable, meaning that a model defined in MongoEngine can be read in MotorEngine. The source is - `available on github `_. + `available on GitHub `_. uMongo `uMongo `_ is a Python MongoDB ODM. Its inception comes from two needs: the lack of async ODM and the difficulty to do document (un)serialization with existing ODMs. Works with multiple drivers: PyMongo, TxMongo, motor_asyncio, and - mongomock. The source `is available on github + mongomock. The source `is available on GitHub `_ No longer maintained @@ -91,7 +91,7 @@ MongoKit MongoAlchemy `MongoAlchemy `_ is another ORM-like layer on top of PyMongo. Its API is inspired by `SQLAlchemy `_. The - code is available `on github `_; + code is available `on GitHub `_; for more information, see `the tutorial `_. Minimongo @@ -99,14 +99,14 @@ Minimongo pythonic interface to MongoDB. It retains pymongo's query and update API, and provides a number of additional features, including a simple document-oriented interface, connection pooling, index management, and - collection & database naming helpers. The `source is on github + collection & database naming helpers. The `source is on GitHub `_. Manga `Manga `_ aims to be a simpler ORM-like layer on top of PyMongo. The syntax for defining schema is inspired by the Django ORM, but Pymongo's query language is maintained. The source `is on - github `_. + GitHub `_. Framework Tools --------------- @@ -115,8 +115,8 @@ various Python frameworks and libraries. * `Djongo `_ is a connector for using Django with MongoDB as the database backend. Use the Django Admin GUI to add and - modify documents in MongoDB. - The `Djongo Source Code `_ is hosted on github + modify documents in MongoDB. + The `Djongo Source Code `_ is hosted on GitHub and the `Djongo package `_ is on pypi. * `Django MongoDB Engine `_ is a MongoDB @@ -133,7 +133,7 @@ various Python frameworks and libraries. * `mongodb_beaker `_ is a project to enable using MongoDB as a backend for `beaker's `_ caching / session system. - `The source is on github `_. + `The source is on GitHub `_. * `Log4Mongo `_ is a flexible Python logging handler that can store logs in MongoDB using normal and capped collections.