diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-19 20:09:35 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2020-07-19 20:09:35 -0500 |
| commit | 7309c0df45496e66007ea3838442413f4a3056f2 (patch) | |
| tree | f62e4550965c12ad6ebc6abf652ac690069a4408 | |
| parent | Change name of BaseParser to AbstractParser (diff) | |
| download | config-file-7309c0df45496e66007ea3838442413f4a3056f2.zip | |
Add napoleon to transition to Google docstring format
| -rw-r--r-- | docs/source/conf.py | 6 | ||||
| -rw-r--r-- | poetry.lock | 33 | ||||
| -rw-r--r-- | pyproject.toml | 5 |
3 files changed, 40 insertions, 4 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 1c16a92..69cfce0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -31,7 +31,11 @@ release = "0.10.0" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosectionlabel"] +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosectionlabel", + "sphinx.ext.napoleon", +] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] diff --git a/poetry.lock b/poetry.lock index afe6577..ea4dca0 100644 --- a/poetry.lock +++ b/poetry.lock @@ -370,6 +370,17 @@ dev = ["pre-commit", "tox"] [[package]] category = "dev" +description = "A collection of helpful Python tools!" +name = "pockets" +optional = false +python-versions = "*" +version = "0.9.1" + +[package.dependencies] +six = ">=1.5.2" + +[[package]] +category = "dev" description = "A framework for managing and maintaining multi-language pre-commit hooks." name = "pre-commit" optional = false @@ -649,6 +660,18 @@ test = ["pytest", "flake8", "mypy"] [[package]] category = "dev" +description = "Sphinx \"napoleon\" extension." +name = "sphinxcontrib-napoleon" +optional = false +python-versions = "*" +version = "0.7" + +[package.dependencies] +pockets = ">=0.3" +six = ">=1.5.2" + +[[package]] +category = "dev" description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." name = "sphinxcontrib-qthelp" optional = false @@ -771,7 +794,7 @@ toml = ["toml"] yaml = ["pyyaml"] [metadata] -content-hash = "432d63eaf6fb166650820be893bb3364a954b8fcf81b618bbfb398dbb54de1f6" +content-hash = "c3cc44b7d09a63e8aba8852464f06543d403a4091727bad9f58ee881c60f18dd" python-versions = "^3.6" [metadata.files] @@ -976,6 +999,10 @@ pluggy = [ {file = "pluggy-0.13.1-py2.py3-none-any.whl", hash = "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d"}, {file = "pluggy-0.13.1.tar.gz", hash = "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0"}, ] +pockets = [ + {file = "pockets-0.9.1-py2.py3-none-any.whl", hash = "sha256:68597934193c08a08eb2bf6a1d85593f627c22f9b065cc727a4f03f669d96d86"}, + {file = "pockets-0.9.1.tar.gz", hash = "sha256:9320f1a3c6f7a9133fe3b571f283bcf3353cd70249025ae8d618e40e9f7e92b3"}, +] pre-commit = [ {file = "pre_commit-1.21.0-py2.py3-none-any.whl", hash = "sha256:f92a359477f3252452ae2e8d3029de77aec59415c16ae4189bcfba40b757e029"}, {file = "pre_commit-1.21.0.tar.gz", hash = "sha256:8f48d8637bdae6fa70cc97db9c1dd5aa7c5c8bf71968932a380628c25978b850"}, @@ -1091,6 +1118,10 @@ sphinxcontrib-jsmath = [ {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, ] +sphinxcontrib-napoleon = [ + {file = "sphinxcontrib-napoleon-0.7.tar.gz", hash = "sha256:407382beed396e9f2d7f3043fad6afda95719204a1e1a231ac865f40abcbfcf8"}, + {file = "sphinxcontrib_napoleon-0.7-py2.py3-none-any.whl", hash = "sha256:711e41a3974bdf110a484aec4c1a556799eb0b3f3b897521a018ad7e2db13fef"}, +] sphinxcontrib-qthelp = [ {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"}, {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"}, diff --git a/pyproject.toml b/pyproject.toml index 4ac2043..846059c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,12 +43,13 @@ seed-isort-config = { version = "^2.1.1", python = "^3.6.1" } pytest = "^5.4.1" pytest-cov = "^2.8.1" pytest-sugar = "^0.9.3" -sphinx = "^2.4.4" -sphinx_rtd_theme = "^0.4.3" taskipy = "^1.2.1" bump2version = "^1.0.0" flake8 = "^3.7.9" black = "^19.10b0" +sphinx = "^2.4.4" +sphinx_rtd_theme = "^0.4.3" +sphinxcontrib-napoleon = "^0.7" [tool.black] line-length = 88 |