From 0d4b8e82aee9f62386d09bd1af420289fa8cefa6 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Fri, 9 Sep 2022 10:24:58 -0500 Subject: [PATCH] fix: docs --- poetry.lock | 56 ++++++++++++++++++++++++++++++-------------------- pyproject.toml | 1 + 2 files changed, 35 insertions(+), 22 deletions(-) diff --git a/poetry.lock b/poetry.lock index 829afa25..16b3ec72 100644 --- a/poetry.lock +++ b/poetry.lock @@ -3,7 +3,7 @@ name = "alabaster" version = "0.7.12" description = "A configurable sidebar-enabled Sphinx theme" category = "main" -optional = true +optional = false python-versions = "*" [[package]] @@ -25,7 +25,7 @@ name = "babel" version = "2.10.3" description = "Internationalization utilities" category = "main" -optional = true +optional = false python-versions = ">=3.6" [package.dependencies] @@ -36,7 +36,7 @@ name = "certifi" version = "2022.6.15" description = "Python package for providing Mozilla's CA Bundle." category = "main" -optional = true +optional = false python-versions = ">=3.6" [[package]] @@ -44,7 +44,7 @@ name = "charset-normalizer" version = "2.1.1" description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." category = "main" -optional = true +optional = false python-versions = ">=3.6.0" [package.extras] @@ -77,7 +77,7 @@ name = "docutils" version = "0.17.1" description = "Docutils -- Python Documentation Utilities" category = "main" -optional = true +optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [[package]] @@ -85,7 +85,7 @@ name = "idna" version = "3.3" description = "Internationalized Domain Names in Applications (IDNA)" category = "main" -optional = true +optional = false python-versions = ">=3.5" [[package]] @@ -93,7 +93,7 @@ name = "imagesize" version = "1.4.1" description = "Getting image size from png/jpeg/jpeg2000/gif file" category = "main" -optional = true +optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] @@ -126,7 +126,7 @@ name = "jinja2" version = "3.1.2" description = "A very fast and expressive template engine." category = "main" -optional = true +optional = false python-versions = ">=3.7" [package.dependencies] @@ -162,7 +162,7 @@ name = "markupsafe" version = "2.1.1" description = "Safely add untrusted strings to HTML/XML markup." category = "main" -optional = true +optional = false python-versions = ">=3.7" [[package]] @@ -251,7 +251,7 @@ name = "pygments" version = "2.13.0" description = "Pygments is a syntax highlighting package written in Python." category = "main" -optional = true +optional = false python-versions = ">=3.6" [package.extras] @@ -324,7 +324,7 @@ name = "pytz" version = "2022.2.1" description = "World timezone definitions, modern and historical" category = "main" -optional = true +optional = false python-versions = "*" [[package]] @@ -340,7 +340,7 @@ name = "requests" version = "2.28.1" description = "Python HTTP for Humans." category = "main" -optional = true +optional = false python-versions = ">=3.7, <4" [package.dependencies] @@ -358,7 +358,7 @@ name = "snowballstemmer" version = "2.2.0" description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." category = "main" -optional = true +optional = false python-versions = "*" [[package]] @@ -366,7 +366,7 @@ name = "sphinx" version = "5.1.1" description = "Python documentation generator" category = "main" -optional = true +optional = false python-versions = ">=3.6" [package.dependencies] @@ -413,19 +413,30 @@ name = "sphinxcontrib-applehelp" version = "1.0.2" description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" category = "main" -optional = true +optional = false python-versions = ">=3.5" [package.extras] test = ["pytest"] lint = ["docutils-stubs", "mypy", "flake8"] +[[package]] +name = "sphinxcontrib-asyncio" +version = "0.3.0" +description = "sphinx extension to support coroutines in markup" +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +sphinx = ">=3.0" + [[package]] name = "sphinxcontrib-devhelp" version = "1.0.2" description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." category = "main" -optional = true +optional = false python-versions = ">=3.5" [package.extras] @@ -437,7 +448,7 @@ name = "sphinxcontrib-htmlhelp" version = "2.0.0" description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" category = "main" -optional = true +optional = false python-versions = ">=3.6" [package.extras] @@ -449,7 +460,7 @@ name = "sphinxcontrib-jsmath" version = "1.0.1" description = "A sphinx extension which renders display math in HTML via JavaScript" category = "main" -optional = true +optional = false python-versions = ">=3.5" [package.extras] @@ -460,7 +471,7 @@ name = "sphinxcontrib-qthelp" version = "1.0.3" description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." category = "main" -optional = true +optional = false python-versions = ">=3.5" [package.extras] @@ -472,7 +483,7 @@ name = "sphinxcontrib-serializinghtml" version = "1.1.5" description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." category = "main" -optional = true +optional = false python-versions = ">=3.5" [package.extras] @@ -500,7 +511,7 @@ name = "urllib3" version = "1.26.12" description = "HTTP library with thread-safe connection pooling, file post, and more." category = "main" -optional = true +optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4" [package.extras] @@ -526,7 +537,7 @@ docs = ["myst-parser", "Sphinx", "sphinx-rtd-theme"] [metadata] lock-version = "1.1" python-versions = "^3.7" -content-hash = "2c9314a941f6be6f7ef96dd996650261032c8c3530abdeef4bfdfc4bca8c9fed" +content-hash = "43ff8cac973dfd191afe3253536f6cfac7e4e191e0f6a6e6fbe6a58fcc5701fc" [metadata.files] alabaster = [] @@ -562,6 +573,7 @@ snowballstemmer = [] sphinx = [] sphinx-rtd-theme = [] sphinxcontrib-applehelp = [] +sphinxcontrib-asyncio = [] sphinxcontrib-devhelp = [] sphinxcontrib-htmlhelp = [] sphinxcontrib-jsmath = [] diff --git a/pyproject.toml b/pyproject.toml index 95ec2d31..df9987b3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,6 +29,7 @@ python = "^3.7" Sphinx = {version = "^5.0", optional = true} sphinx-rtd-theme = {version = "^1.0", optional = true} myst-parser = {version = "^0.18", optional = true} +sphinxcontrib-asyncio = {version = "^0.3.0", extras = ["docs"]} [tool.poetry.extras] docs = [