Skip to content

Commit

Permalink
Merge branch 'fix-doc-landing-page-links' into stable
Browse files Browse the repository at this point in the history
* fix-doc-landing-page-links:
  Make internal links refer to same version
  • Loading branch information
prkumar committed Sep 14, 2018
2 parents 8b53f71 + a62843b commit d350b40
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 5 additions & 9 deletions docs/source/index.rst
Expand Up @@ -66,36 +66,32 @@ Features
- **Bring Your Own HTTP Library**

- `Non-blocking I/O support`_ for Aiohttp and Twisted
- `Supply your own session`_ (e.g., :class:`requests.Session`) for greater control
- :ref:`Supply your own session <swap_default_http_client>` (e.g., :class:`requests.Session`) for greater control

- **Easy and Transparent Deserialization/Serialization**

- Define `custom converters`_ for your own objects
- Support for |marshmallow|_ schemas and `handling collections`_ (e.g., list of Users)
- Define :ref:`custom converters <custom_json_deserialization>` for your own objects
- Support for |marshmallow|_ schemas and :ref:`handling collections <converting_collections>` (e.g., list of Users)

- **Extendable**

- Install optional plugins for additional features (e.g., `protobuf support`_)
- Compose `custom response and error handling`_ functions as middleware
- Compose :ref:`custom response and error handling <custom response handler>` functions as middleware

- **Authentication**

- Built-in support for `Basic Authentication`_
- Built-in support for :ref:`Basic Authentication <basic_authentication>`
- Use existing auth libraries for supported clients (e.g., |requests-oauthlib|_)

Uplink officially supports Python 2.7 & 3.3-3.7.

.. |marshmallow| replace:: ``marshmallow``
.. |requests-oauthlib| replace:: ``requests-oauthlib``
.. _`Non-blocking I/O support`: https://github.com/prkumar/uplink/tree/master/examples/async-requests
.. _`Supply your own session`: https://uplink.readthedocs.io/en/latest/user/clients.html#swapping-out-the-default-http-session
.. _`marshmallow`: https://github.com/prkumar/uplink/tree/master/examples/marshmallow
.. _`custom converters`: https://uplink.readthedocs.io/en/latest/user/serialization.html#custom-json-deserialization
.. _`handling collections`: https://uplink.readthedocs.io/en/latest/user/serialization.html#converting-collections
.. _`custom response and error handling`: https://uplink.readthedocs.io/en/latest/user/quickstart.html#response-and-error-handling
.. _`protobuf support`: https://github.com/prkumar/uplink-protobuf
.. _`requests-oauthlib`: https://github.com/requests/requests-oauthlib
.. _`Basic Authentication`: https://uplink.readthedocs.io/en/latest/user/auth.html#basic-authentication

User Testimonials
=================
Expand Down
2 changes: 2 additions & 0 deletions docs/source/user/auth.rst
Expand Up @@ -3,6 +3,8 @@ Authentication

This section covers how to do authentication with Uplink.

.. _basic_authentication:

Basic Authentication
--------------------

Expand Down
2 changes: 2 additions & 0 deletions docs/source/user/serialization.rst
Expand Up @@ -145,6 +145,8 @@ be explicitly provided through the :py:obj:`converter` parameter:
def user_loader(user_cls, json):
return user_cls(json["id"], json["username"])
.. _converting_collections:

Converting Collections
======================

Expand Down

0 comments on commit d350b40

Please sign in to comment.