diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html index e9162697b..2c085fc5d 100644 --- a/docs/_templates/sidebarintro.html +++ b/docs/_templates/sidebarintro.html @@ -60,8 +60,8 @@

Useful Links

Translations

diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html index f5e634c71..605909bc3 100644 --- a/docs/_templates/sidebarlogo.html +++ b/docs/_templates/sidebarlogo.html @@ -42,8 +42,8 @@

Other Projects

Translations

diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst index bb3f9487c..848d7ae34 100644 --- a/docs/dev/virtualenvs.rst +++ b/docs/dev/virtualenvs.rst @@ -122,7 +122,7 @@ control by adding it to the ignore list. virtualenvwrapper ----------------- -`virtualenvwrapper `_ +`virtualenvwrapper `_ provides a set of commands which makes working with virtual environments much more pleasant. It also places all your virtual environments in one place. @@ -134,7 +134,7 @@ To install (make sure **virtualenv** is already installed): $ export WORKON_HOME=~/Envs $ source /usr/local/bin/virtualenvwrapper.sh -(`Full virtualenvwrapper install instructions `_.) +(`Full virtualenvwrapper install instructions `_.) For Windows, you can use the `virtualenvwrapper-win `_. @@ -206,7 +206,7 @@ Other useful commands ``lssitepackages`` Shows contents of :file:`site-packages` directory. -`Full list of virtualenvwrapper commands `_. +`Full list of virtualenvwrapper commands `_. virtualenv-burrito ------------------ diff --git a/docs/intro/learning.rst b/docs/intro/learning.rst index 8ab660867..823da5bab 100644 --- a/docs/intro/learning.rst +++ b/docs/intro/learning.rst @@ -38,7 +38,7 @@ without having to install Python locally. If you want a more traditional book, *Python For You and Me* is an excellent resource for learning all aspects of the language. - `Python for You and Me `_ + `Python for You and Me `_ Online Python Tutor ~~~~~~~~~~~~~~~~~~~ diff --git a/docs/scenarios/ci.rst b/docs/scenarios/ci.rst index aa8d1968f..16e0ea0df 100644 --- a/docs/scenarios/ci.rst +++ b/docs/scenarios/ci.rst @@ -35,7 +35,7 @@ automate the compile/test cycle to validate code changes. Tox --- -`tox `_ is an automation tool providing +`tox `_ is an automation tool providing packaging, testing and deployment of Python software right from the console or CI server. It is a generic virtualenv management and test command line tool which provides the following features: diff --git a/docs/scenarios/clibs.rst b/docs/scenarios/clibs.rst index bae907b6b..82e041fe3 100644 --- a/docs/scenarios/clibs.rst +++ b/docs/scenarios/clibs.rst @@ -4,7 +4,7 @@ Interfacing with C/C++ Libraries C Foreign Function Interface ---------------------------- -`CFFI `_ provides a simple to use +`CFFI `_ provides a simple to use mechanism for interfacing with C from both CPython and PyPy. It supports two modes: an inline ABI compatibility mode (example provided below), which allows you to dynamically load and run functions from executable modules (essentially diff --git a/docs/scenarios/db.rst b/docs/scenarios/db.rst index 3ed11914f..58d9cd20b 100644 --- a/docs/scenarios/db.rst +++ b/docs/scenarios/db.rst @@ -60,11 +60,11 @@ peewee `peewee `_ is another ORM with a focus on being lightweight with support for Python 2.6+ and 3.2+ which supports SQLite, MySQL and Postgres by default. The -`model layer `_ +`model layer `_ is similar to that of the Django ORM and it has -`SQL-like methods `_ +`SQL-like methods `_ to query data. While SQLite, MySQL and Postgres are supported out-of-the-box, -there is a `collection of add-ons `_ +there is a `collection of add-ons `_ available. PonyORM diff --git a/docs/scenarios/gui.rst b/docs/scenarios/gui.rst index 854fb826c..f56b212b7 100644 --- a/docs/scenarios/gui.rst +++ b/docs/scenarios/gui.rst @@ -28,7 +28,7 @@ applications be ported from PyGTK to PyGObject. PyGObject aka (PyGi) -------------------- `PyGObject `_ provides Python bindings, which gives access to the entire GNOME software platform. -It is fully compatible with GTK+ 3. Here is a tutorial to get started with `Python GTK+ 3 Tutorial `_. +It is fully compatible with GTK+ 3. Here is a tutorial to get started with `Python GTK+ 3 Tutorial `_. `API Reference `_ diff --git a/docs/scenarios/imaging.rst b/docs/scenarios/imaging.rst index 23ecece49..49d3af1eb 100644 --- a/docs/scenarios/imaging.rst +++ b/docs/scenarios/imaging.rst @@ -24,7 +24,7 @@ Installation Before installing Pillow, you'll have to install Pillow's prerequisites. Find the instructions for your platform in the -`Pillow installation instructions `_. +`Pillow installation instructions `_. After that, it's straightforward: @@ -57,7 +57,7 @@ Example exif_data There are more examples of the Pillow library in the -`Pillow tutorial `_. +`Pillow tutorial `_. OpenSource Computer Vision @@ -104,4 +104,4 @@ Example There are more Python-implemented examples of OpenCV in this `collection of tutorials -`_. +`_. diff --git a/docs/scenarios/json.rst b/docs/scenarios/json.rst index b5145fc4c..860e79435 100644 --- a/docs/scenarios/json.rst +++ b/docs/scenarios/json.rst @@ -47,7 +47,7 @@ simplejson The JSON library was added to Python in version 2.6. If you're using an earlier version of Python, the -`simplejson `_ library is +`simplejson `_ library is available via PyPI. simplejson mimics the json standard library. It is available so that developers diff --git a/docs/scenarios/web.rst b/docs/scenarios/web.rst index 601e880a1..9e07a59f5 100644 --- a/docs/scenarios/web.rst +++ b/docs/scenarios/web.rst @@ -154,7 +154,7 @@ Gunicorn is the recommended choice for new Python web applications today. Waitress -------- -`Waitress `_ is a pure-python WSGI server +`Waitress `_ is a pure-python WSGI server that claims "very acceptable performance". Its documentation is not very detailed, but it does offer some nice functionality that Gunicorn doesn't have (e.g. HTTP request buffering). @@ -166,18 +166,18 @@ Waitress is gaining popularity within the Python web development community. uWSGI ----- -`uWSGI `_ is a full stack for building +`uWSGI `_ is a full stack for building hosting services. In addition to process management, process monitoring, and other functionality, uWSGI acts as an application server for various programming languages and protocols - including Python and WSGI. uWSGI can either be run as a stand-alone web router, or be run behind a full web server (such as Nginx or Apache). In the latter case, a web server can configure uWSGI and an application's operation over the -`uwsgi protocol `_. +`uwsgi protocol `_. uWSGI's web server support allows for dynamically configuring Python, passing environment variables and further tuning. For full details, see `uWSGI magic -variables `_. +variables `_. I do not recommend using uWSGI unless you know why you need it. @@ -393,10 +393,10 @@ Jinja2 is the recommended templating library for new Python web applications. Chameleon --------- -`Chameleon `_ Page Templates are an HTML/XML template +`Chameleon `_ Page Templates are an HTML/XML template engine implementation of the `Template Attribute Language (TAL) `_, -`TAL Expression Syntax (TALES) `_, -and `Macro Expansion TAL (Metal) `_ syntaxes. +`TAL Expression Syntax (TALES) `_, +and `Macro Expansion TAL (Metal) `_ syntaxes. Chameleon is available for Python 2.5 and up (including 3.x and pypy), and is commonly used by the `Pyramid Framework `_. diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index 596ebafc1..c67957529 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -25,7 +25,7 @@ and being able and willing to use tools such as pip to install your code's other dependencies. This is fine when distributing to other developers, but makes this method unsuitable for distributing applications to end-users. -The `Python Packaging Guide `_ +The `Python Packaging Guide `_ provides an extensive guide on creating and maintaining Python packages. Alternatives to Packaging @@ -184,4 +184,4 @@ Useful Tools - `fpm `_ - `alien `_ -- `dh-virtualenv `_ (for APT/DEB omnibus packaging) +- `dh-virtualenv `_ (for APT/DEB omnibus packaging) diff --git a/docs/starting/install/osx.rst b/docs/starting/install/osx.rst index 03426c554..422248590 100644 --- a/docs/starting/install/osx.rst +++ b/docs/starting/install/osx.rst @@ -77,7 +77,7 @@ software over a network (usually the Internet) with a single command capability to your own Python software with very little work. ``pip`` is a tool for easily installing and managing Python packages, -that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_, +that is recommended over ``easy_install``. It is superior to ``easy_install`` in `several ways `_, and is actively maintained. diff --git a/docs/writing/tests.rst b/docs/writing/tests.rst index 08495300d..b8b7ca022 100644 --- a/docs/writing/tests.rst +++ b/docs/writing/tests.rst @@ -202,7 +202,7 @@ nose provides automatic test discovery to save you the hassle of manually creating test suites. It also provides numerous plugins for features such as xUnit-compatible test output, coverage reporting, and test selection. - `nose `_ + `nose `_ tox