Skip to content

Commit

Permalink
Use :doc: instead of :ref: to refer to pages...
Browse files Browse the repository at this point in the history
...Also, use :pr: role in some recent changelog entries
  • Loading branch information
sloria committed Jul 14, 2018
1 parent a721931 commit ee5ee8c
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 17 deletions.
12 changes: 6 additions & 6 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ Bug fixes:

Other changes:

* *Backwards-incompatible*: Drop support for Python 3.4 (:issue:`243`). Python 2.7 and
* *Backwards-incompatible*: Drop support for Python 3.4 (:pr:`243`). Python 2.7 and
>=3.5 are supported.
* *Backwards-incompatible*: Drop support for marshmallow<2.15.0.
marshmallow>=2.15.0 and >=3.0.0b12 are officially supported.
* Use `black <https://github.com/ambv/black>`_ with `pre-commit <https://pre-commit.com/>`_
for code formatting.
for code formatting (:pr:`244`).

3.0.2 (2018-07-05)
******************

Bug fixes:

* Fix compatibility with marshmallow 3.0.0b12 (:issue:`242`). Thanks :user:`lafrech`.
* Fix compatibility with marshmallow 3.0.0b12 (:pr:`242`). Thanks :user:`lafrech`.

3.0.1 (2018-06-06)
******************
Expand Down Expand Up @@ -64,7 +64,7 @@ Changes:
* *Backwards-incompatible*: Remove unused ``instance`` and ``kwargs`` arguments of ``argmap2schema``.
* *Backwards-incompatible*: Remove ``Parser.load`` method (``Parser`` now calls ``Schema.load`` directly).

These changes shouldn't affect most users. However, they might break custom parsers calling these methods. (:issue:`222`)
These changes shouldn't affect most users. However, they might break custom parsers calling these methods. (:pr:`222`)

* Drop support for aiohttp<3.0.0.

Expand All @@ -90,7 +90,7 @@ Changes:

Features:

* Add support for marshmallow>=3.0.0b7 (:issue:`188`). Thanks
* Add support for marshmallow>=3.0.0b7 (:pr:`188`). Thanks
:user:`lafrech`.

Deprecations:
Expand All @@ -104,7 +104,7 @@ Changes:

* ``HTTPExceptions`` raised with `webargs.flaskparser.abort` will always
have the ``data`` attribute, even if no additional keywords arguments
are passed (:issue:`184`). Thanks :user:`lafrech`.
are passed (:pr:`184`). Thanks :user:`lafrech`.

Support:

Expand Down
4 changes: 1 addition & 3 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _advanced:

Advanced Usage
==============

Expand Down Expand Up @@ -364,5 +362,5 @@ To reduce boilerplate, you could create shortcuts, like so:
Next Steps
----------

- See the :ref:`Framework Support <frameworks>` page for framework-specific guides.
- See the :doc:`Framework Support <framework_support>` page for framework-specific guides.
- For example applications, check out the `examples <https://github.com/sloria/webargs/tree/dev/examples>`_ directory.
2 changes: 0 additions & 2 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
.. _changelog:

.. include:: ../CHANGELOG.rst
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ webargs
A friendly library for parsing HTTP request arguments.


Release v\ |version|. (:ref:`Changelog <changelog>`)
Release v\ |version|. (:doc:`Changelog <changelog>`)

webargs is a Python library for parsing HTTP request arguments, with built-in support for popular web frameworks, including Flask, Django, Bottle, Tornado, Pyramid, webapp2, Falcon, and aiohttp.

Expand Down Expand Up @@ -81,7 +81,7 @@ Get It Now

pip install -U webargs

Ready to get started? Go on to the :ref:`Quickstart tutorial <quickstart>` or check out some `examples <https://github.com/sloria/webargs/tree/dev/examples>`_.
Ready to get started? Go on to the :doc:`Quickstart tutorial <quickstart>` or check out some `examples <https://github.com/sloria/webargs/tree/dev/examples>`_.

User Guide
----------
Expand Down
6 changes: 2 additions & 4 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
.. _quickstart:

Quickstart
==========

Expand Down Expand Up @@ -227,6 +225,6 @@ Nesting Fields
Next Steps
----------

- Go on to :ref:`Advanced Usage <advanced>` to learn how to add custom location handlers, use marshmallow Schemas, and more.
- See the :ref:`Framework Support <frameworks>` page for framework-specific guides.
- Go on to :doc:`Advanced Usage <advanced>` to learn how to add custom location handlers, use marshmallow Schemas, and more.
- See the :doc:`Framework Support <framework_support>` page for framework-specific guides.
- For example applications, check out the `examples <https://github.com/sloria/webargs/tree/dev/examples>`_ directory.

0 comments on commit ee5ee8c

Please sign in to comment.