aboutsummaryrefslogtreecommitdiffstats
path: root/pyproject.toml
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2021-12-02 14:46:48 +0400
committerGravatar Hassan Abouelela <[email protected]>2021-12-02 15:31:51 +0400
commit1370b89fb924ae889bc128de8b93578cc0101239 (patch)
treec29402f2925a576a9a6edccc7649cf445ee88c06 /pyproject.toml
parentPort Regex Utilities From Python Bot (diff)
Add Sphinx Docs
Adds a customized sphinx doc builder.
Diffstat (limited to 'pyproject.toml')
-rw-r--r--pyproject.toml11
1 files changed, 10 insertions, 1 deletions
diff --git a/pyproject.toml b/pyproject.toml
index fad0f24a..18cfb4f9 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -15,8 +15,14 @@ packages = [
exclude = ["tests", "tests.*"]
[tool.poetry.dependencies]
-python = "^3.9"
+python = "3.9.*"
"discord.py" = "^1.7.2"
+Sphinx = "^4.3.1"
+tomli = "^1.2.2"
+GitPython = "^3.1.24"
+sphinx-autodoc-typehints = "^1.12.0"
+releases = "^1.6.3"
+furo = "^2021.11.23"
[tool.poetry.dev-dependencies]
flake8 = "~=3.8"
@@ -38,6 +44,9 @@ pytest-xdist = { version = "~=2.3.0", extras = ["psutil"] }
[tool.taskipy.tasks]
lint = "pre-commit run --all-files"
precommit = "pre-commit install"
+apidoc = "sphinx-apidoc -o docs/output botcore -fe"
+builddoc = "sphinx-build -nW -j auto -b html docs docs/build"
+docs = "task apidoc && task builddoc"
[build-system]
requires = ["poetry-core>=1.0.0"]