Update dependencies and improve documentation (#6)

* Update docs dependencies * improve documentation
TheJecksMan · Apr 17, 2024 · dbf8a01 · dbf8a01
1 parent bd954a8
commit dbf8a01
Show file tree

Hide file tree

Showing 6 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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 → examples/fastapi_example.py b/examples/fastapi.py → examples/fastapi_example.py
diff --git a/examples/starlette.py → examples/starlette_example.py b/examples/starlette.py → examples/starlette_example.py
diff --git 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