From 71755bb5a07aeb466de5b00336100d2a38bc9a83 Mon Sep 17 00:00:00 2001 From: Caleb Stewart Date: Fri, 31 Dec 2021 17:12:31 -0500 Subject: [PATCH 1/3] Updated enum-tools and moved to furo theme --- docs/source/conf.py | 2 +- poetry.lock | 76 +++++++++++++++++++++++---------------------- pyproject.toml | 4 +-- 3 files changed, 42 insertions(+), 40 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6d45ecc..80faa23 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -43,7 +43,7 @@ exclude_patterns = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/poetry.lock b/poetry.lock index 13d8626..dbe6aa1 100644 --- a/poetry.lock +++ b/poetry.lock @@ -44,17 +44,17 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "attrs" -version = "21.2.0" +version = "21.4.0" description = "Classes Without Boilerplate" category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.extras] -dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit"] +dev = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "furo", "sphinx", "sphinx-notfound-page", "pre-commit", "cloudpickle"] docs = ["furo", "sphinx", "zope.interface", "sphinx-notfound-page"] -tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface"] -tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins"] +tests = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "zope.interface", "cloudpickle"] +tests_no_zope = ["coverage[toml] (>=5.0.2)", "hypothesis", "pympler", "pytest (>=4.3.0)", "six", "mypy", "pytest-mypy-plugins", "cloudpickle"] [[package]] name = "autodocsumm" @@ -312,7 +312,7 @@ dates = ["pytz (>=2019.1)"] [[package]] name = "enum-tools" -version = "0.6.5" +version = "0.7.0" description = "Tools to expand Python's enum module." category = "dev" optional = false @@ -323,8 +323,8 @@ pygments = ">=2.6.1" typing-extensions = ">=3.7.4.3" [package.extras] -sphinx = ["sphinx (>=3.0.3,<3.5.0)", "sphinx-toolbox (>=1.2.0)"] -all = ["sphinx (>=3.0.3,<3.5.0)", "sphinx-toolbox (>=1.2.0)"] +sphinx = ["sphinx (>=3.2.0,<4.4)", "sphinx-toolbox (>=1.2.0)"] +all = ["sphinx (>=3.2.0,<4.4)", "sphinx-toolbox (>=1.2.0)"] [[package]] name = "flake8" @@ -339,6 +339,23 @@ mccabe = ">=0.6.0,<0.7.0" pycodestyle = ">=2.7.0,<2.8.0" pyflakes = ">=2.3.0,<2.4.0" +[[package]] +name = "furo" +version = "2021.11.23" +description = "A clean customisable Sphinx documentation theme." +category = "dev" +optional = false +python-versions = ">=3.6" + +[package.dependencies] +beautifulsoup4 = "*" +pygments = ">=2.7,<3.0" +sphinx = ">=4.0,<5.0" + +[package.extras] +test = ["pytest", "pytest-cov", "pytest-xdist"] +doc = ["myst-parser", "sphinx-copybutton", "sphinx-design", "sphinx-inline-tabs"] + [[package]] name = "html5lib" version = "1.1" @@ -577,7 +594,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "pygments" -version = "2.10.0" +version = "2.11.1" description = "Pygments is a syntax highlighting package written in Python." category = "main" optional = false @@ -683,7 +700,7 @@ jupyter = ["ipywidgets (>=7.5.1,<8.0.0)"] [[package]] name = "ruamel.yaml" -version = "0.17.18" +version = "0.17.19" description = "ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order" category = "main" optional = false @@ -786,21 +803,6 @@ python-versions = "*" pygments = "*" Sphinx = "*" -[[package]] -name = "sphinx-rtd-theme" -version = "0.5.2" -description = "Read the Docs theme for Sphinx" -category = "dev" -optional = false -python-versions = "*" - -[package.dependencies] -docutils = "<0.17" -sphinx = "*" - -[package.extras] -dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] - [[package]] name = "sphinx-tabs" version = "3.2.0" @@ -1135,7 +1137,7 @@ testing = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] [metadata] lock-version = "1.1" python-versions = "^3.9" -content-hash = "f22eb6fbfeb891da37974f1e70b5d971cc11b3672be47bb4ce0a887d43340f46" +content-hash = "1e480b20c2371e582d857d9d05bed0c5b4a0cdc228dfcc68f54997a1cb76815e" [metadata.files] alabaster = [ @@ -1155,8 +1157,8 @@ atomicwrites = [ {file = "atomicwrites-1.4.0.tar.gz", hash = "sha256:ae70396ad1a434f9c7046fd2dd196fc04b12f9e91ffb859164193be8b6168a7a"}, ] attrs = [ - {file = "attrs-21.2.0-py2.py3-none-any.whl", hash = "sha256:149e90d6d8ac20db7a955ad60cf0e6881a3f20d37096140088356da6c716b0b1"}, - {file = "attrs-21.2.0.tar.gz", hash = "sha256:ef6aaac3ca6cd92904cdd0d83f629a15f18053ec84e6432106f7a4d04ae4f5fb"}, + {file = "attrs-21.4.0-py2.py3-none-any.whl", hash = "sha256:2d27e3784d7a565d36ab851fe94887c5eccd6a463168875832a1be79c82828b4"}, + {file = "attrs-21.4.0.tar.gz", hash = "sha256:626ba8234211db98e869df76230a137c4c40a12d72445c45d5f5b716f076e2fd"}, ] autodocsumm = [ {file = "autodocsumm-0.2.7.tar.gz", hash = "sha256:cea7e2f900e5ac10baa6e831683e9241b0892226210609c087b94f109e0f6ab6"}, @@ -1353,13 +1355,17 @@ domdf-python-tools = [ {file = "domdf_python_tools-3.1.0-py3-none-any.whl", hash = "sha256:2a50d992f705a9e68d653f877267d007baeea7e6f95614ab68bd9ca57f7f7ba0"}, ] enum-tools = [ - {file = "enum_tools-0.6.5-py3-none-any.whl", hash = "sha256:f4b5b9c3e12e768face4a1a11c3af46c7355477ec0936cd5c73687047e14f78a"}, - {file = "enum_tools-0.6.5.tar.gz", hash = "sha256:f1db631125f145e1eb0db9e2c14e2069da1bcb6a6959481d070901df77d47ee9"}, + {file = "enum_tools-0.7.0-py3-none-any.whl", hash = "sha256:94b8494b128d72923d34e422254beba3bfbad94d19166806578777fa9788eda5"}, + {file = "enum_tools-0.7.0.tar.gz", hash = "sha256:826638ff4ab1c4294e06d7bbb681095509d205486d2f1684efb5514c8327ae1d"}, ] flake8 = [ {file = "flake8-3.9.2-py2.py3-none-any.whl", hash = "sha256:bf8fd333346d844f616e8d47905ef3a3384edae6b4e9beb0c5101e25e3110907"}, {file = "flake8-3.9.2.tar.gz", hash = "sha256:07528381786f2a6237b061f6e96610a4167b226cb926e2aa2b6b1d78057c576b"}, ] +furo = [ + {file = "furo-2021.11.23-py3-none-any.whl", hash = "sha256:6d396451ad1aadce380c662fca9362cb10f4fd85f296d74fe3ca32006eb641d7"}, + {file = "furo-2021.11.23.tar.gz", hash = "sha256:54cecac5f3b688b5c7370d72ecdf1cd91a6c53f0f42751f4a719184b562cde70"}, +] html5lib = [ {file = "html5lib-1.1-py2.py3-none-any.whl", hash = "sha256:0d78f8fde1c230e99fe37986a60526d7049ed4bf8a9fadbad5f00e22e58e041d"}, {file = "html5lib-1.1.tar.gz", hash = "sha256:b2e5b40261e20f354d198eae92afc10d750afb487ed5e50f9c4eaf07c184146f"}, @@ -1622,8 +1628,8 @@ pyflakes = [ {file = "pyflakes-2.3.1.tar.gz", hash = "sha256:f5bc8ecabc05bb9d291eb5203d6810b49040f6ff446a756326104746cc00c1db"}, ] pygments = [ - {file = "Pygments-2.10.0-py3-none-any.whl", hash = "sha256:b8e67fe6af78f492b3c4b3e2970c0624cbf08beb1e493b2c99b9fa1b67a20380"}, - {file = "Pygments-2.10.0.tar.gz", hash = "sha256:f398865f7eb6874156579fdf36bc840a03cab64d1cde9e93d68f46a425ec52c6"}, + {file = "Pygments-2.11.1-py3-none-any.whl", hash = "sha256:9135c1af61eec0f650cd1ea1ed8ce298e54d56bcd8cc2ef46edd7702c171337c"}, + {file = "Pygments-2.11.1.tar.gz", hash = "sha256:59b895e326f0fb0d733fd28c6839bd18ad0687ba20efc26d4277fd1d30b971f4"}, ] pynacl = [ {file = "PyNaCl-1.4.0-cp27-cp27m-macosx_10_10_x86_64.whl", hash = "sha256:ea6841bc3a76fa4942ce00f3bda7d436fda21e2d91602b9e21b7ca9ecab8f3ff"}, @@ -1699,8 +1705,8 @@ rich = [ {file = "rich-10.16.1.tar.gz", hash = "sha256:4949e73de321784ef6664ebbc854ac82b20ff60b2865097b93f3b9b41e30da27"}, ] "ruamel.yaml" = [ - {file = "ruamel.yaml-0.17.18-py3-none-any.whl", hash = "sha256:9c648677803a2e9570c1116d15ba4fd89198c8966171868044bee2181cae8ab3"}, - {file = "ruamel.yaml-0.17.18.tar.gz", hash = "sha256:92b85e64a1d75adc29f941960f5a88dcf3d233a0ba0c3d0a864ca9645a9b7271"}, + {file = "ruamel.yaml-0.17.19-py3-none-any.whl", hash = "sha256:92ac00b312c9a83ff3253a8f7b86dfe6f9996b4082b103af84b8df99175945bc"}, + {file = "ruamel.yaml-0.17.19.tar.gz", hash = "sha256:b9ce9a925d0f0c35a1dbba56b40f253c53cd526b0fa81cf7b1d24996f28fb1d7"}, ] "ruamel.yaml.clib" = [ {file = "ruamel.yaml.clib-0.2.6-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:6e7be2c5bcb297f5b82fee9c665eb2eb7001d1050deaba8471842979293a80b0"}, @@ -1752,10 +1758,6 @@ sphinx-autodoc-typehints = [ sphinx-prompt = [ {file = "sphinx_prompt-1.5.0-py3-none-any.whl", hash = "sha256:fa4e90d8088b5a996c76087d701fc7e31175f8b9dc4aab03a507e45051067162"}, ] -sphinx-rtd-theme = [ - {file = "sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl", hash = "sha256:4a05bdbe8b1446d77a01e20a23ebc6777c74f43237035e76be89699308987d6f"}, - {file = "sphinx_rtd_theme-0.5.2.tar.gz", hash = "sha256:32bd3b5d13dc8186d7a42fc816a23d32e83a4827d7d9882948e7b837c232da5a"}, -] sphinx-tabs = [ {file = "sphinx-tabs-3.2.0.tar.gz", hash = "sha256:33137914ed9b276e6a686d7a337310ee77b1dae316fdcbce60476913a152e0a4"}, {file = "sphinx_tabs-3.2.0-py3-none-any.whl", hash = "sha256:1e1b1846c80137bd81a78e4a69b02664b98b1e1da361beb30600b939dfc75065"}, diff --git a/pyproject.toml b/pyproject.toml index 2cecacf..87e833d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -49,9 +49,9 @@ sphinx-toolbox = "^2.15.2" isort = "^5.8.0" pytest = "^6.2.4" Sphinx = "^4.0.2" -sphinx-rtd-theme = "^0.5.2" -enum-tools = "^0.6.4" +enum-tools = "^0.7.0" flake8 = "^3.9.2" +furo = "^2021.11.23" [build-system] requires = ["poetry-core>=1.0.0"] From fe25624c8e6eeb84a627bcb521f20b3fa7737cbd Mon Sep 17 00:00:00 2001 From: Caleb Stewart Date: Fri, 31 Dec 2021 17:45:18 -0500 Subject: [PATCH 2/3] Added docs extra to manage docs dependencies --- .readthedocs.yaml | 3 +- poetry.lock | 117 ++++++++++++++++++++++++---------------------- pyproject.toml | 11 +++-- 3 files changed, 69 insertions(+), 62 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1ec2c0f..52852ab 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,4 +12,5 @@ python: install: - method: pip path: . - - requirements: docs/requirements.txt + extra_requirements: + - docs diff --git a/poetry.lock b/poetry.lock index dbe6aa1..7d4713a 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 = false +optional = true python-versions = "*" [[package]] @@ -11,7 +11,7 @@ name = "apeye" version = "1.1.0" description = "Handy tools for working with URLs and APIs." category = "main" -optional = false +optional = true python-versions = ">=3.6.1" [package.dependencies] @@ -31,7 +31,7 @@ name = "appdirs" version = "1.4.4" description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -39,7 +39,7 @@ name = "atomicwrites" version = "1.4.0" description = "Atomic file writes." category = "dev" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] @@ -47,7 +47,7 @@ name = "attrs" version = "21.4.0" description = "Classes Without Boilerplate" category = "dev" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.extras] @@ -61,7 +61,7 @@ name = "autodocsumm" version = "0.2.7" description = "Extended sphinx autodoc including automatic autosummaries" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -72,7 +72,7 @@ name = "babel" version = "2.9.1" description = "Internationalization utilities" category = "main" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [package.dependencies] @@ -99,7 +99,7 @@ name = "beautifulsoup4" version = "4.10.0" description = "Screen-scraping library" category = "main" -optional = false +optional = true python-versions = ">3.0.0" [package.dependencies] @@ -131,7 +131,7 @@ name = "cachecontrol" version = "0.12.10" description = "httplib2 caching for requests" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -178,7 +178,7 @@ name = "click" version = "8.0.3" description = "Composable command line interface toolkit" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -208,7 +208,7 @@ name = "consolekit" version = "1.3.0" description = "Additional utilities for click." category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -248,7 +248,7 @@ name = "css-parser" version = "1.0.6" description = "A CSS Cascading Style Sheets library for Python" category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -256,7 +256,7 @@ name = "deprecation" version = "2.1.0" description = "A library to handle automated deprecations" category = "main" -optional = false +optional = true python-versions = "*" [package.dependencies] @@ -267,7 +267,7 @@ name = "deprecation-alias" version = "0.2.0" description = "A wrapper around 'deprecation' providing support for deprecated aliases." category = "main" -optional = false +optional = true python-versions = ">=3.6.1" [package.dependencies] @@ -279,7 +279,7 @@ name = "dict2css" version = "0.2.4" description = "A μ-library for constructing cascading style sheets from Python dictionaries." category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -291,7 +291,7 @@ name = "docutils" version = "0.16" description = "Docutils -- Python Documentation Utilities" category = "main" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [[package]] @@ -299,7 +299,7 @@ name = "domdf-python-tools" version = "3.1.0" description = "Helpful functions for Python 🐍 🛠️" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -314,8 +314,8 @@ dates = ["pytz (>=2019.1)"] name = "enum-tools" version = "0.7.0" description = "Tools to expand Python's enum module." -category = "dev" -optional = false +category = "main" +optional = true python-versions = ">=3.6" [package.dependencies] @@ -331,7 +331,7 @@ name = "flake8" version = "3.9.2" description = "the modular source code checker: pep8 pyflakes and co" category = "dev" -optional = false +optional = true python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7" [package.dependencies] @@ -343,8 +343,8 @@ pyflakes = ">=2.3.0,<2.4.0" name = "furo" version = "2021.11.23" description = "A clean customisable Sphinx documentation theme." -category = "dev" -optional = false +category = "main" +optional = true python-versions = ">=3.6" [package.dependencies] @@ -361,7 +361,7 @@ name = "html5lib" version = "1.1" description = "HTML parser based on the WHATWG HTML specification" category = "main" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [package.dependencies] @@ -387,7 +387,7 @@ name = "imagesize" version = "1.3.0" description = "Getting image size from png/jpeg/jpeg2000/gif file" category = "main" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] @@ -395,7 +395,7 @@ name = "iniconfig" version = "1.1.1" description = "iniconfig: brain-dead simple config-ini parsing" category = "dev" -optional = false +optional = true python-versions = "*" [[package]] @@ -403,7 +403,7 @@ name = "isort" version = "5.10.1" description = "A Python utility / library to sort Python imports." category = "dev" -optional = false +optional = true python-versions = ">=3.6.1,<4.0" [package.extras] @@ -431,7 +431,7 @@ name = "lockfile" version = "0.12.2" description = "Platform-independent file locking module" category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -447,7 +447,7 @@ name = "mccabe" version = "0.6.1" description = "McCabe checker, plugin for flake8" category = "dev" -optional = false +optional = true python-versions = "*" [[package]] @@ -455,7 +455,7 @@ name = "mistletoe" version = "0.8.1" description = "A fast, extensible Markdown parser in pure Python." category = "main" -optional = false +optional = true python-versions = "~=3.3" [[package]] @@ -463,7 +463,7 @@ name = "msgpack" version = "1.0.3" description = "MessagePack (de)serializer." category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -471,7 +471,7 @@ name = "natsort" version = "8.0.2" description = "Simple yet flexible natural sorting in Python." category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.extras] @@ -534,7 +534,7 @@ name = "pluggy" version = "1.0.0" description = "plugin and hook calling mechanisms for python" category = "dev" -optional = false +optional = true python-versions = ">=3.6" [package.extras] @@ -557,7 +557,7 @@ name = "py" version = "1.11.0" description = "library with cross-python path, ini-parsing, io, code, log facilities" category = "dev" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" [[package]] @@ -565,7 +565,7 @@ name = "pycodestyle" version = "2.7.0" description = "Python style guide checker" category = "dev" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] @@ -589,7 +589,7 @@ name = "pyflakes" version = "2.3.1" description = "passive checker of Python programs" category = "dev" -optional = false +optional = true python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] @@ -632,7 +632,7 @@ name = "pytest" version = "6.2.5" description = "pytest: simple powerful testing with Python" category = "dev" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -661,7 +661,7 @@ name = "pytz" version = "2021.3" description = "World timezone definitions, modern and historical" category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -703,7 +703,7 @@ name = "ruamel.yaml" version = "0.17.19" description = "ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order" category = "main" -optional = false +optional = true python-versions = ">=3" [package.dependencies] @@ -718,7 +718,7 @@ name = "ruamel.yaml.clib" version = "0.2.6" description = "C version of reader, parser and emitter for ruamel.yaml derived from libyaml" category = "main" -optional = false +optional = true python-versions = ">=3.5" [[package]] @@ -734,7 +734,7 @@ name = "snowballstemmer" version = "2.2.0" description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -742,7 +742,7 @@ name = "soupsieve" version = "2.3.1" description = "A modern CSS selector implementation for Beautiful Soup." category = "main" -optional = false +optional = true python-versions = ">=3.6" [[package]] @@ -750,7 +750,7 @@ name = "sphinx" version = "4.3.2" description = "Python documentation generator" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -781,7 +781,7 @@ name = "sphinx-autodoc-typehints" version = "1.11.1" description = "Type hints (PEP 484) support for the Sphinx autodoc extension" category = "main" -optional = false +optional = true python-versions = ">=3.5.2" [package.dependencies] @@ -796,7 +796,7 @@ name = "sphinx-prompt" version = "1.5.0" description = "Sphinx directive to add unselectable prompt" category = "main" -optional = false +optional = true python-versions = "*" [package.dependencies] @@ -808,7 +808,7 @@ name = "sphinx-tabs" version = "3.2.0" description = "Tabbed views for Sphinx" category = "main" -optional = false +optional = true python-versions = "~=3.6" [package.dependencies] @@ -825,7 +825,7 @@ name = "sphinx-toolbox" version = "2.15.2" description = "Box of handy tools for Sphinx 🧰 📔" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.dependencies] @@ -855,7 +855,7 @@ name = "sphinxcontrib-applehelp" version = "1.0.2" description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" category = "main" -optional = false +optional = true python-versions = ">=3.5" [package.extras] @@ -867,7 +867,7 @@ name = "sphinxcontrib-devhelp" version = "1.0.2" description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." category = "main" -optional = false +optional = true python-versions = ">=3.5" [package.extras] @@ -879,7 +879,7 @@ name = "sphinxcontrib-htmlhelp" version = "2.0.0" description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" category = "main" -optional = false +optional = true python-versions = ">=3.6" [package.extras] @@ -891,7 +891,7 @@ name = "sphinxcontrib-jsmath" version = "1.0.1" description = "A sphinx extension which renders display math in HTML via JavaScript" category = "main" -optional = false +optional = true python-versions = ">=3.5" [package.extras] @@ -902,7 +902,7 @@ name = "sphinxcontrib-qthelp" version = "1.0.3" description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." category = "main" -optional = false +optional = true python-versions = ">=3.5" [package.extras] @@ -914,7 +914,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 = false +optional = true python-versions = ">=3.5" [package.extras] @@ -926,7 +926,7 @@ name = "tabulate" version = "0.8.9" description = "Pretty-print tabular data" category = "main" -optional = false +optional = true python-versions = "*" [package.extras] @@ -937,7 +937,7 @@ name = "toml" version = "0.10.2" description = "Python Library for Tom's Obvious, Minimal Language" category = "dev" -optional = false +optional = true python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" [[package]] @@ -961,7 +961,7 @@ name = "typing-extensions" version = "4.0.1" description = "Backported and Experimental Type Hints for Python 3.6+" category = "main" -optional = false +optional = true python-versions = ">=3.6" [[package]] @@ -990,7 +990,7 @@ name = "webencodings" version = "0.5.1" description = "Character encoding aliases for legacy web content" category = "main" -optional = false +optional = true python-versions = "*" [[package]] @@ -1134,10 +1134,13 @@ docs = ["sphinx", "repoze.sphinx.autointerface"] test = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] testing = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] +[extras] +docs = ["sphinx-toolbox", "Sphinx", "enum-tools", "furo"] + [metadata] lock-version = "1.1" python-versions = "^3.9" -content-hash = "1e480b20c2371e582d857d9d05bed0c5b4a0cdc228dfcc68f54997a1cb76815e" +content-hash = "550298dd8a174525c9b9655568b1173cd8f2b20dfeda626a27ee0cac242e8d5d" [metadata.files] alabaster = [ diff --git a/pyproject.toml b/pyproject.toml index 87e833d..b7ba676 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,15 +43,18 @@ zodburi = "^2.5.0" Jinja2 = "^3.0.1" paramiko-ng = "^2.8.8" PyNaCl = "^1.4.0" -sphinx-toolbox = "^2.15.2" +sphinx-toolbox = { version = "^2.15.2", optional = true } +Sphinx = { version= "^4.0.2", optional = true } +enum-tools = { version= "^0.7.0", optional = true } +furo = { version= "^2021.11.23", optional = true } [tool.poetry.dev-dependencies] isort = "^5.8.0" pytest = "^6.2.4" -Sphinx = "^4.0.2" -enum-tools = "^0.7.0" flake8 = "^3.9.2" -furo = "^2021.11.23" + +[tool.poetry.extras] +docs = ["sphinx-toolbox", "Sphinx", "enum-tools", "furo"] [build-system] requires = ["poetry-core>=1.0.0"] From 7257a48f5ea27d32cbe72a414d84ed9efd419106 Mon Sep 17 00:00:00 2001 From: Caleb Stewart Date: Fri, 31 Dec 2021 17:54:56 -0500 Subject: [PATCH 3/3] Updated changelog and remove docs/requirements.txt --- CHANGELOG.md | 2 ++ docs/requirements.txt | 4 ---- 2 files changed, 2 insertions(+), 4 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index e824582..18eb87f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,8 @@ and simply didn't have the time to go back and retroactively create one. - Added implant module `list` command to match documentation ([#224](https://github.com/calebstewart/pwncat/issues/224)). - Update documentation to clarify implant reconnection - Fixed `--ssl` argument parsing for bind channels. +- Moved documentation theme to [furo](https://github.com/pradyunsg/furo). +- Added Extras group for documentation depenedencies and removed `docs/requirements.txt`. ## [0.5.1] - 2021-12-07 Minor bug fixes. Mainly typos from changing the package name. diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 8554ce5..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -sphinx-toolbox==2.11.2 -apeye<1.0.0 -enum-tools==0.6.4 -sphinx_rtd_theme==1.0.0