Skip to content

Commit

Permalink
Tweak docs (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
Dreamsorcerer authored Aug 15, 2024
1 parent 00bb26d commit 62138e7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
aiohttp_apischema
aiohttp-apischema
=================
.. image:: https://github.com/aio-libs/aiohttp-apischema/workflows/CI/badge.svg
:target: https://github.com/aio-libs/aiohttp-apischema/actions?query=workflow%3ACI
Expand Down
10 changes: 6 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
aiohttp_apischema
aiohttp-apischema
=================

.. currentmodule:: aiohttp_apischema
Expand Down Expand Up @@ -30,7 +30,7 @@ the return type:
async def foo(request: web.Request) -> APIResponse[list[str], Literal[200]]:
return APIResponse(["foo"])
Or for `Class Based Views <https://aiohttp.readthedocs.io/en/stable/web_quickstart.html#class-based-views>`_
Or for :ref:`Class Based Views <aiohttp:aiohttp-web-class-based-views>`
the :meth:`aiohttp_apischema.SchemaGenerator.api_view` decorator can be used:

.. code-block:: python
Expand Down Expand Up @@ -91,9 +91,11 @@ You can use docstrings to customise the summary and description shown in the sch
Library Installation
--------------------

The :mod:`aiohttp_apischema` library can be installed with pip::
The :mod:`aiohttp_apischema` library can be installed with pip:

$ pip install aiohttp_apischema
.. code-block:: sh
$ pip install aiohttp-apischema
Source code
-----------
Expand Down

0 comments on commit 62138e7

Please sign in to comment.