From dbf8a019b1db53be5fab41b0c765ed52b5641687 Mon Sep 17 00:00:00 2001 From: Dmitry <71208143+TheJecksMan@users.noreply.github.com> Date: Wed, 17 Apr 2024 12:03:35 +0300 Subject: [PATCH] Update dependencies and improve documentation (#6) * Update docs dependencies * improve documentation --- .readthedocs.yaml | 2 +- docs/examples.fastapi.rst | 2 +- docs/examples.starlette.rst | 2 +- examples/{fastapi.py => fastapi_example.py} | 0 examples/{starlette.py => starlette_example.py} | 0 requirements-docs.txt | 2 +- 6 files changed, 4 insertions(+), 4 deletions(-) rename examples/{fastapi.py => fastapi_example.py} (100%) rename examples/{starlette.py => starlette_example.py} (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9bf7924..527a9c5 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "3.12" # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/docs/examples.fastapi.rst b/docs/examples.fastapi.rst index e906564..3d3dba4 100644 --- a/docs/examples.fastapi.rst +++ b/docs/examples.fastapi.rst @@ -3,5 +3,5 @@ FastAPI The simplest example for FastAPI, which demonstrates the work of this library. -.. literalinclude:: ../examples/fastapi.py +.. literalinclude:: ../examples/fastapi_example.py :language: python diff --git a/docs/examples.starlette.rst b/docs/examples.starlette.rst index 35dba61..7a122fe 100644 --- a/docs/examples.starlette.rst +++ b/docs/examples.starlette.rst @@ -3,5 +3,5 @@ Starlette The simplest example for Starlette, which demonstrates the work of this library. -.. literalinclude:: ../examples/starlette.py +.. literalinclude:: ../examples/starlette_example.py :language: python diff --git a/examples/fastapi.py b/examples/fastapi_example.py similarity index 100% rename from examples/fastapi.py rename to examples/fastapi_example.py diff --git a/examples/starlette.py b/examples/starlette_example.py similarity index 100% rename from examples/starlette.py rename to examples/starlette_example.py diff --git a/requirements-docs.txt b/requirements-docs.txt index 392b4ea..90b12a4 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,3 +1,3 @@ -sphinx==7.2.6 +sphinx>=7.3.5,<7.4.0 furo>=2023.5.20 sphinx-copybutton>=0.5.1