Skip to content

Commit

Permalink
Fix documentation links
Browse files Browse the repository at this point in the history
These have been incorrect since the switch to github.
  • Loading branch information
pgjones committed Nov 19, 2023
1 parent f68a8cf commit 6dd64da
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Quart-Trio
|Build Status| |docs| |pypi| |python| |license|

Quart-Trio is an extension for `Quart
<https://gitlab.com/pgjones/quart>`__ to support the `Trio
<https://github.com/pallets/quart>`__ to support the `Trio
<https://trio.readthedocs.io/en/latest/>`_ event loop. This is an
alternative to using the asyncio event loop present in the Python
standard library and supported by default in Quart.
Expand All @@ -20,7 +20,7 @@ QuartTrio can be installed via `pip
$ pip install quart-trio
and requires Python 3.8 or higher (see `python version support
<https://pgjones.gitlab.io/quart/discussion/python_versions.html>`_
<https://quart.palletsprojects.com/en/latest/discussion/python_versions.html>`_
for reasoning).

A minimal Quart example is,
Expand Down Expand Up @@ -50,7 +50,7 @@ if the above is in a file called ``app.py`` it can be run as,
$ python app.py
To deploy in a production setting see the `deployment
<https://pgjones.github.io/quart-trio/tutorials/deployment.html>`_
<https://quart-trio.readthedocs.io/en/latest/tutorials/deployment.html>`_
documentation.

Contributing
Expand All @@ -77,8 +77,8 @@ this will check the code style and run the tests.
Help
----

The `Quart-Trio <https://pgjones.github.io/quart-trio/>`__ and `Quart
<https://pgjones.github.io/quart/>`__ documentation are the best
The `Quart-Trio <https://quart-trio.readthedocs.io>`__ and `Quart
<https://quart.palletsprojects.com>`__ documentation are the best
places to start, after that try searching `stack overflow
<https://stackoverflow.com/questions/tagged/quart>`_, if you still
can't find an answer please `open an issue
Expand Down
2 changes: 1 addition & 1 deletion docs/how_to_guides/background_tasks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Background Tasks
================

Background tasks work with the same API as for `Quart
<https://pgjones.gitlab.io/quart/how_to_guides/background_tasks.html>`_
<https://quart.palletsprojects.com/en/latest/how_to_guides/background_tasks.html>`_
with the tasks themselves running on a nursery stored on the app,
``app.nursery``.

Expand Down
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.. title:: Quart-Trio documentation

Quart-Trio is an extension for `Quart
<https://gitlab.com/pgjones/quart>`_ to support the `Trio
<https://github.com/pallets/quart>`_ to support the `Trio
<https://trio.readthedocs.io/>`_ event loop. This is an alternative to
using the asyncio event loop present in the Python standard library
and supported by default in Quart.
Expand All @@ -18,7 +18,8 @@ propose `merge requests

Quart-Trio is a Quart extension, therefore this documentation only
mentions differences to Quart. Please consider the `Quart docs
<https://pgjones.gitlab.io/quart/>`_ for general usage information.
<https://quart.palletsprojects.com>`_ for general usage
information.


Contents
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Deploying Quart-Trio

It is not recommended to run Quart-Trio apps directly (via
:meth:`~quart_trio.app.QuartTrio.run`) in production. Instead it is
recommended that `Hypercorn <https://gitlab.com/pgjones/hypercorn>`_
recommended that `Hypercorn <https://github.com/pgjones/hypercorn>`_
is used. This is becuase the :meth:`~quart_trio.app.QuartTrio.run`
enables features that help development yet slow production
performance. Hypercorn is installed with QuartTrio and will be used to
Expand Down Expand Up @@ -35,4 +35,4 @@ you can run with Hypercorn using,
hypercorn -k trio example:app
See the `Hypercorn docs <https://pgjones.gitlab.io/hypercorn/>`_.
See the `Hypercorn docs <https://hypercorn.readthedocs.io/>`_.

0 comments on commit 6dd64da

Please sign in to comment.