From d6c3c97bc20aae4b2132967587cbaf8878381f09 Mon Sep 17 00:00:00 2001 From: BenYuan Date: Fri, 1 Nov 2024 19:35:27 +0000 Subject: [PATCH 1/2] Added sphinx-paramlinks --- poetry.lock | 20 +++++++++++++++++--- pyproject.toml | 1 + 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/poetry.lock b/poetry.lock index 1f35613ad..c5bf23c24 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. [[package]] name = "accessible-pygments" @@ -4518,6 +4518,20 @@ sphinx = ">=5" doc = ["sphinx-autoapi", "sphinx-rtd-theme", "sphinx-tabs", "sphinxemoji"] test = ["tox"] +[[package]] +name = "sphinx-paramlinks" +version = "0.6.0" +description = "Allows param links in Sphinx function/method descriptions to be linkable" +optional = true +python-versions = "*" +files = [ + {file = "sphinx-paramlinks-0.6.0.tar.gz", hash = "sha256:746a0816860aa3fff5d8d746efcbec4deead421f152687411db1d613d29f915e"}, +] + +[package.dependencies] +docutils = "*" +Sphinx = ">=4.0.0" + [[package]] name = "sphinx-prompt" version = "1.8.0" @@ -5124,9 +5138,9 @@ cffi = {version = ">=1.11", markers = "platform_python_implementation == \"PyPy\ cffi = ["cffi (>=1.11)"] [extras] -docs = ["autodoc_pydantic", "cairosvg", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "pydata-sphinx-theme", "readthedocs-sphinx-search", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-favicon", "sphinx-notfound-page", "sphinx-prompt", "sphinx-sitemap", "sphinx-tabs", "sphinx_design", "sphinx_toolbox", "sphinxcontrib-svg2pdfconverter", "sphinxemoji"] +docs = ["autodoc_pydantic", "cairosvg", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "pydata-sphinx-theme", "readthedocs-sphinx-search", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-favicon", "sphinx-notfound-page", "sphinx-prompt", "sphinx-sitemap", "sphinx-tabs", "sphinx_design", "sphinx_paramlinks", "sphinx_toolbox", "sphinxcontrib-svg2pdfconverter", "sphinxemoji"] [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.12" -content-hash = "06a25622fff3a3c4612d1326ada848e08eb1e83c2ddf19c348a1164963090061" +content-hash = "36dec9798969328c8fbdec1653c06be84e930017773db1263682439cd5c962cc" diff --git a/pyproject.toml b/pyproject.toml index c772725ae..185588b85 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -59,6 +59,7 @@ sphinxcontrib-svg2pdfconverter = {version="*", optional = true} sphinx-prompt = {version="*", optional = true} sphinx_design = {version="*", optional = true} sphinx_toolbox = {version="*", optional = true} +sphinx_paramlinks = {version="*", optional = true} [tool.poetry.group.dev.dependencies] From 86302764d6614ecd0833ff2f8bd052d7ee15a8e7 Mon Sep 17 00:00:00 2001 From: BenYuan Date: Fri, 1 Nov 2024 20:09:39 +0000 Subject: [PATCH 2/2] Add more dependencies --- poetry.lock | 49 +++++++++++++++++++++++++++++++++++-------------- pyproject.toml | 2 ++ 2 files changed, 37 insertions(+), 14 deletions(-) diff --git a/poetry.lock b/poetry.lock index c5bf23c24..68082fdf1 100644 --- a/poetry.lock +++ b/poetry.lock @@ -22,7 +22,7 @@ tests = ["hypothesis", "pytest"] name = "alabaster" version = "0.7.16" description = "A light, configurable Sphinx theme" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "alabaster-0.7.16-py3-none-any.whl", hash = "sha256:b46733c07dce03ae4e150330b975c75737fa60f0a7c591b6c8bf4928a28e2c92"}, @@ -1107,7 +1107,7 @@ profile = ["gprof2dot (>=2022.7.29)"] name = "docutils" version = "0.21.2" description = "Docutils -- Python Documentation Utilities" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "docutils-0.21.2-py3-none-any.whl", hash = "sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2"}, @@ -1466,7 +1466,7 @@ all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2 name = "imagesize" version = "1.4.1" description = "Getting image size from png/jpeg/jpeg2000/gif file" -optional = true +optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" files = [ {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"}, @@ -2912,6 +2912,27 @@ files = [ {file = "numpy-1.26.0.tar.gz", hash = "sha256:f93fc78fe8bf15afe2b8d6b6499f1c73953169fad1e9a8dd086cdff3190e7fdf"}, ] +[[package]] +name = "numpydoc" +version = "1.8.0" +description = "Sphinx extension to support docstrings in Numpy format" +optional = false +python-versions = ">=3.9" +files = [ + {file = "numpydoc-1.8.0-py3-none-any.whl", hash = "sha256:72024c7fd5e17375dec3608a27c03303e8ad00c81292667955c6fea7a3ccf541"}, + {file = "numpydoc-1.8.0.tar.gz", hash = "sha256:022390ab7464a44f8737f79f8b31ce1d3cfa4b4af79ccaa1aac5e8368db587fb"}, +] + +[package.dependencies] +sphinx = ">=6" +tabulate = ">=0.8.10" +tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} + +[package.extras] +developer = ["pre-commit (>=3.3)", "tomli"] +doc = ["intersphinx-registry", "matplotlib (>=3.5)", "numpy (>=1.22)", "pydata-sphinx-theme (>=0.13.3)", "sphinx (>=7)"] +test = ["matplotlib", "pytest", "pytest-cov"] + [[package]] name = "overrides" version = "7.7.0" @@ -4330,7 +4351,7 @@ files = [ name = "snowballstemmer" version = "2.2.0" description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms." -optional = true +optional = false python-versions = "*" files = [ {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, @@ -4352,7 +4373,7 @@ files = [ name = "sphinx" version = "7.4.7" description = "Python documentation generator" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinx-7.4.7-py3-none-any.whl", hash = "sha256:c2419e2135d11f1951cd994d6eb18a1835bd8fdd8429f9ca375dc1f3281bd239"}, @@ -4623,7 +4644,7 @@ testing = ["coincidence (>=0.4.3)", "pygments (>=2.7.4,<=2.13.0)"] name = "sphinxcontrib-applehelp" version = "2.0.0" description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinxcontrib_applehelp-2.0.0-py3-none-any.whl", hash = "sha256:4cd3f0ec4ac5dd9c17ec65e9ab272c9b867ea77425228e68ecf08d6b28ddbdb5"}, @@ -4639,7 +4660,7 @@ test = ["pytest"] name = "sphinxcontrib-devhelp" version = "2.0.0" description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinxcontrib_devhelp-2.0.0-py3-none-any.whl", hash = "sha256:aefb8b83854e4b0998877524d1029fd3e6879210422ee3780459e28a1f03a8a2"}, @@ -4655,7 +4676,7 @@ test = ["pytest"] name = "sphinxcontrib-htmlhelp" version = "2.1.0" description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl", hash = "sha256:166759820b47002d22914d64a075ce08f4c46818e17cfc9470a9786b759b19f8"}, @@ -4671,7 +4692,7 @@ test = ["html5lib", "pytest"] name = "sphinxcontrib-jsmath" version = "1.0.1" description = "A sphinx extension which renders display math in HTML via JavaScript" -optional = true +optional = false python-versions = ">=3.5" files = [ {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, @@ -4685,7 +4706,7 @@ test = ["flake8", "mypy", "pytest"] name = "sphinxcontrib-qthelp" version = "2.0.0" description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinxcontrib_qthelp-2.0.0-py3-none-any.whl", hash = "sha256:b18a828cdba941ccd6ee8445dbe72ffa3ef8cbe7505d8cd1fa0d42d3f2d5f3eb"}, @@ -4701,7 +4722,7 @@ test = ["defusedxml (>=0.7.1)", "pytest"] name = "sphinxcontrib-serializinghtml" version = "2.0.0" description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)" -optional = true +optional = false python-versions = ">=3.9" files = [ {file = "sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl", hash = "sha256:6e2cb0eef194e10c27ec0023bfeb25badbbb5868244cf5bc5bdc04e4464bf331"}, @@ -4784,7 +4805,7 @@ dev = ["hypothesis (>=6.70.0)", "pytest (>=7.1.0)"] name = "tabulate" version = "0.9.0" description = "Pretty-print tabular data" -optional = true +optional = false python-versions = ">=3.7" files = [ {file = "tabulate-0.9.0-py3-none-any.whl", hash = "sha256:024ca478df22e9340661486f85298cff5f6dcdba14f3813e8830015b9ed1948f"}, @@ -5138,9 +5159,9 @@ cffi = {version = ">=1.11", markers = "platform_python_implementation == \"PyPy\ cffi = ["cffi (>=1.11)"] [extras] -docs = ["autodoc_pydantic", "cairosvg", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "pydata-sphinx-theme", "readthedocs-sphinx-search", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-favicon", "sphinx-notfound-page", "sphinx-prompt", "sphinx-sitemap", "sphinx-tabs", "sphinx_design", "sphinx_paramlinks", "sphinx_toolbox", "sphinxcontrib-svg2pdfconverter", "sphinxemoji"] +docs = ["autodoc_pydantic", "cairosvg", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "numpydoc", "pydata-sphinx-theme", "readthedocs-sphinx-search", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-favicon", "sphinx-notfound-page", "sphinx-prompt", "sphinx-sitemap", "sphinx-tabs", "sphinx_design", "sphinx_paramlinks", "sphinx_toolbox", "sphinxcontrib-svg2pdfconverter", "sphinxemoji"] [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.12" -content-hash = "36dec9798969328c8fbdec1653c06be84e930017773db1263682439cd5c962cc" +content-hash = "f98d5ccabd7699df12cdbcda67892f6707f774e22d3680ac424e94f9a40582bd" diff --git a/pyproject.toml b/pyproject.toml index 185588b85..7a548e470 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -60,6 +60,7 @@ sphinx-prompt = {version="*", optional = true} sphinx_design = {version="*", optional = true} sphinx_toolbox = {version="*", optional = true} sphinx_paramlinks = {version="*", optional = true} +numpydoc = "^1.8.0" [tool.poetry.group.dev.dependencies] @@ -101,6 +102,7 @@ docs = [ "sphinx_design", "sphinx_toolbox", "sphinx_paramlinks", + "numpydoc" ] [tool.isort]