Feat/readthedocs (#200)

fix documentation deploy
05bit · Jan 11, 2024 · 15d202c · 15d202c
1 parent d14e602
commit 15d202c
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 9 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+sphinx:
+  configuration: docs/conf.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -113,7 +113,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/peewee_async/api_older.rst b/docs/peewee_async/api_older.rst
@@ -7,10 +7,6 @@ Select, update, delete
 ----------------------
 
 .. autofunction:: peewee_async.execute
-.. autofunction:: peewee_async.get_object
-.. autofunction:: peewee_async.create_object
-.. autofunction:: peewee_async.delete_object
-.. autofunction:: peewee_async.update_object
 .. autofunction:: peewee_async.prefetch
 
 Transactions

diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,12 +18,16 @@ aiomysql = { version = "^0.2.0", optional = true }
 cryptography = { version = "^41.0.3", optional = true }
 pytest = { version = "^7.4.1", optional = true }
 pytest-asyncio = { version = "^0.21.1", optional = true }
+sphinx = { version = "^7.1.2", optional = true }
+sphinx-rtd-theme = { version = "^1.3.0rc1", optional = true }
+
 
 
 [tool.poetry.extras]
 postgresql = ["aiopg"]
 mysql = ["aiomysql", "cryptography"]
 develop = ["aiopg", "aiomysql", "cryptography", "pytest", "pytest-asyncio"]
+docs = ["aiopg", "aiomysql", "cryptography", "sphinx", "sphinx-rtd-theme"]
 
 [build-system]
 requires = ["poetry-core"]