diff --git a/.gitignore b/.gitignore index fca79a31a1efdbdacbd427ce79f5363a554454b7..fbc352a6d6279297b31d1012f653101fca9c1b58 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,7 @@ settings.json /notes/ *.offsets *.pkl + +# Docs build +/build/docs +/public diff --git a/poetry.lock b/poetry.lock index 9eda7ccf0fdeaaebdb63de95e64edc3b0134e52f..9e6d673d21101e6d3c9660a42852b5c54d3816c7 100644 --- a/poetry.lock +++ b/poetry.lock @@ -80,6 +80,14 @@ category = "main" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +[[package]] +name = "click" +version = "7.1.2" +description = "Composable command line interface toolkit" +category = "main" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" + [[package]] name = "colorama" version = "0.4.4" @@ -126,6 +134,30 @@ category = "main" optional = false python-versions = ">=3.6, <3.7" +[[package]] +name = "docspec" +version = "0.2.1" +description = "Docspec is a JSON object specification for representing API documentation of programming languages." +category = "main" +optional = false +python-versions = ">=3.6.0,<4.0.0" + +[package.dependencies] +"nr.databind.core" = ">=0.0.19,<0.1.0" +"nr.databind.json" = ">=0.0.9,<0.1.0" + +[[package]] +name = "docspec-python" +version = "0.1.0" +description = "A parser based on lib2to3 producing docspec data from Python source code." +category = "main" +optional = false +python-versions = ">=3.5.0,<4.0.0" + +[package.dependencies] +docspec = ">=0.2.0,<0.3.0" +"nr.sumtype" = ">=0.0.3,<0.1.0" + [[package]] name = "docutils" version = "0.16" @@ -185,7 +217,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "importlib-metadata" -version = "3.7.3" +version = "3.8.0" description = "Read metadata from Python packages" category = "dev" optional = false @@ -197,7 +229,7 @@ zipp = ">=0.5" [package.extras] docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"] -testing = ["pytest (>=3.5,!=3.7.3)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "pytest-enabler", "packaging", "pep517", "pyfakefs", "flufl.flake8", "pytest-black (>=0.3.7)", "pytest-mypy", "importlib-resources (>=1.3)"] +testing = ["pytest (>=4.6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.0.1)", "packaging", "pep517", "pyfakefs", "flufl.flake8", "pytest-black (>=0.3.7)", "pytest-mypy", "importlib-resources (>=1.3)"] [[package]] name = "iniconfig" @@ -356,6 +388,138 @@ linkify = ["linkify-it-py (>=1.0,<2.0)"] rtd = ["sphinxcontrib-bibtex (<2.0.0)", "ipython", "sphinx-book-theme (>=0.0.36)", "sphinx-panels (>=0.5.2,<0.6.0)"] testing = ["coverage", "pytest (>=3.6,<4)", "pytest-cov", "pytest-regressions", "beautifulsoup4"] +[[package]] +name = "nr.collections" +version = "0.0.1" +description = "Useful container datatypes for Python 2 and 3." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.metaclass" = ">=0.0.1,<0.1.0" +six = ">=1.11.0,<2.0.0" + +[package.extras] +test = ["nr.fs (>=1.5.0,<2.0.0)"] + +[[package]] +name = "nr.databind.core" +version = "0.0.22" +description = "Bind structured data directly to typed objects." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.collections" = ">=0.0.1,<1.0.0" +"nr.interface" = ">=0.0.1,<0.1.0" +"nr.pylang.utils" = ">=0.0.3,<0.1.0" +"nr.stream" = ">=0.0.1,<0.1.0" + +[[package]] +name = "nr.databind.json" +version = "0.0.14" +description = "Deserialize JSON into Python objects and reverse." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.collections" = ">=0.0.1,<1.0.0" +"nr.databind.core" = ">=0.0.21,<0.1.0" +"nr.interface" = ">=0.0.1,<0.1.0" +"nr.parsing.date" = ">=0.1.0,<1.0.0" +"nr.pylang.utils" = ">=0.0.1,<0.1.0" + +[[package]] +name = "nr.fs" +version = "1.6.3" +description = "Filesystem and path manipulation tools." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +six = ">=1.11.0,<2.0.0" + +[[package]] +name = "nr.interface" +version = "0.0.4" +description = "Interface definitions for Python." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.collections" = ">=0.0.1,<1.0.0" +"nr.metaclass" = ">=0.0.1,<0.1.0" +"nr.pylang.utils" = ">=0.0.1,<0.1.0" +six = ">=1.11.0,<2.0.0" + +[[package]] +name = "nr.metaclass" +version = "0.0.6" +description = "Metaclass utilities." +category = "main" +optional = false +python-versions = "*" + +[[package]] +name = "nr.parsing.date" +version = "0.6.0" +description = "A simple and fast date parsing library. Uses dateutil for timezone offset support." +category = "main" +optional = false +python-versions = ">=3.5.0,<4.0.0" + +[package.dependencies] +"nr.utils.re" = ">=0.1.0,<0.2.0" + +[[package]] +name = "nr.pylang.utils" +version = "0.0.4" +description = "Package description here." +category = "main" +optional = false +python-versions = ">=3.4.0,<4.0.0" + +[package.dependencies] +"nr.collections" = ">=0.0.1,<1.0.0" + +[[package]] +name = "nr.stream" +version = "0.0.5" +description = "Use iterators like Java streams." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.collections" = ">=0.0.1,<1.0.0" +"nr.pylang.utils" = ">=0.0.1,<1.0.0" +six = ">=1.11.0,<2.0.0" + +[[package]] +name = "nr.sumtype" +version = "0.0.4" +description = "Sumtypes in Python." +category = "main" +optional = false +python-versions = "*" + +[package.dependencies] +"nr.metaclass" = ">=0.0.4,<1.0.0" +"nr.stream" = ">=0.0.2,<1.0.0" + +[[package]] +name = "nr.utils.re" +version = "0.1.1" +description = "This module provides some utility functions for applying regular expressions." +category = "main" +optional = false +python-versions = "*" + [[package]] name = "numpy" version = "1.19.5" @@ -457,6 +621,29 @@ category = "dev" optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +[[package]] +name = "pydoc-markdown" +version = "3.10.0" +description = "Create Python API documentation in Markdown format." +category = "main" +optional = false +python-versions = ">=3.5.0,<4.0.0" + +[package.dependencies] +click = ">=7.0.0,<8.0.0" +docspec = ">=0.2.0,<0.3.0" +docspec-python = ">=0.1.0,<0.2.0" +"nr.collections" = ">=0.0.1,<0.1.0" +"nr.databind.core" = ">=0.0.18,<0.1.0" +"nr.databind.json" = ">=0.0.9,<0.1.0" +"nr.fs" = ">=1.6.0,<2.0.0" +"nr.interface" = ">=0.0.3,<0.1.0" +PyYAML = ">=5.3.0,<6.0.0" +requests = ">=2.23.0,<3.0.0" +six = ">=1.11.0,<2.0.0" +toml = ">=0.10.1,<1.0.0" +watchdog = ">=1.0.0,<2.0.0" + [[package]] name = "pydocstyle" version = "6.0.0" @@ -729,7 +916,7 @@ python-versions = "*" [[package]] name = "sphinx" -version = "3.5.2" +version = "3.5.3" description = "Python documentation generator" category = "main" optional = false @@ -875,7 +1062,7 @@ python-versions = ">=3.5" name = "toml" version = "0.10.2" description = "Python Library for Tom's Obvious, Minimal Language" -category = "dev" +category = "main" optional = false python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" @@ -927,6 +1114,17 @@ python-versions = ">=3.6" [package.dependencies] toml = "*" +[[package]] +name = "watchdog" +version = "1.0.2" +description = "Filesystem events monitoring" +category = "main" +optional = false +python-versions = ">=3.6" + +[package.extras] +watchmedo = ["PyYAML (>=3.10)", "argh (>=0.24.1)"] + [[package]] name = "wrapt" version = "1.12.1" @@ -956,12 +1154,12 @@ docs = ["sphinx", "jaraco.packaging (>=8.2)", "rst.linker (>=1.9)"] testing = ["pytest (>=4.6)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pytest-cov", "pytest-enabler", "jaraco.itertools", "func-timeout", "pytest-black (>=0.3.7)", "pytest-mypy"] [extras] -docs = ["Sphinx", "sphinx-autoapi", "sphinx-rtd-theme", "myst-parser"] +docs = ["Sphinx", "sphinx-autoapi", "sphinx-rtd-theme", "myst-parser", "pydoc-markdown"] [metadata] lock-version = "1.1" python-versions = "^3.6" -content-hash = "e4bcaa64355811624e2a262935d8c627679fc3f3e2ac0aa40436f780336561d6" +content-hash = "c956b903b0181a03705e114226bdd49a3df8655e54b98ee59a2bad05ec55a37c" [metadata.files] alabaster = [ @@ -996,6 +1194,10 @@ chardet = [ {file = "chardet-4.0.0-py2.py3-none-any.whl", hash = "sha256:f864054d66fd9118f2e67044ac8981a54775ec5b67aed0441892edb553d21da5"}, {file = "chardet-4.0.0.tar.gz", hash = "sha256:0d6f53a15db4120f2b08c94f11e7d93d2c911ee118b6b30a04ec3ee8310179fa"}, ] +click = [ + {file = "click-7.1.2-py2.py3-none-any.whl", hash = "sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc"}, + {file = "click-7.1.2.tar.gz", hash = "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a"}, +] colorama = [ {file = "colorama-0.4.4-py2.py3-none-any.whl", hash = "sha256:9f47eda37229f68eee03b24b9748937c7dc3868f906e8ba69fbcbdd3bc5dc3e2"}, {file = "colorama-0.4.4.tar.gz", hash = "sha256:5941b2b48a20143d2267e95b1c2a7603ce057ee39fd88e7329b0c292aa16869b"}, @@ -1095,6 +1297,14 @@ dataclasses = [ {file = "dataclasses-0.8-py3-none-any.whl", hash = "sha256:0201d89fa866f68c8ebd9d08ee6ff50c0b255f8ec63a71c16fda7af82bb887bf"}, {file = "dataclasses-0.8.tar.gz", hash = "sha256:8479067f342acf957dc82ec415d355ab5edb7e7646b90dc6e2fd1d96ad084c97"}, ] +docspec = [ + {file = "docspec-0.2.1-py3-none-any.whl", hash = "sha256:1792cb79d5e6f39aa0c4c17b26b283e2e044b3adb7457151b21e14dca44d5d43"}, + {file = "docspec-0.2.1.tar.gz", hash = "sha256:8ff14da2cdf69a958c3e25c748d629129e38d3145cf5d0c4d55da8e6cfa0cd29"}, +] +docspec-python = [ + {file = "docspec-python-0.1.0.tar.gz", hash = "sha256:8858dc3318b6a67d8452a89ac5c14a15c73f1aa1dd72f9cf63eaa9687082d278"}, + {file = "docspec_python-0.1.0-py3-none-any.whl", hash = "sha256:86561c77dc9ebe4f7d9c224c0740cd66407db849a78580a7509963d4e2c02dfe"}, +] docutils = [ {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"}, {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"}, @@ -1120,8 +1330,8 @@ imagesize = [ {file = "imagesize-1.2.0.tar.gz", hash = "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1"}, ] importlib-metadata = [ - {file = "importlib_metadata-3.7.3-py3-none-any.whl", hash = "sha256:b74159469b464a99cb8cc3e21973e4d96e05d3024d337313fedb618a6e86e6f4"}, - {file = "importlib_metadata-3.7.3.tar.gz", hash = "sha256:742add720a20d0467df2f444ae41704000f50e1234f46174b51f9c6031a1bd71"}, + {file = "importlib_metadata-3.8.0-py3-none-any.whl", hash = "sha256:ce8ae4d781be528001aad74ecfec7512641e36f1272effeea55164e47ae26841"}, + {file = "importlib_metadata-3.8.0.tar.gz", hash = "sha256:9dd89454add8894cc93619426949a58bdad9c1ef42822e46b884e7fc2d2a901e"}, ] iniconfig = [ {file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"}, @@ -1221,6 +1431,49 @@ myst-parser = [ {file = "myst-parser-0.13.5.tar.gz", hash = "sha256:72cf89cc0d6f35070736da19643c9ef52e570e3e13e30c007ad9b94a21f5457a"}, {file = "myst_parser-0.13.5-py3-none-any.whl", hash = "sha256:47e469cef8ba209f4dcb82cd0b4f935171c78c6a2cc0072cd3a9724242eb81ee"}, ] +"nr.collections" = [ + {file = "nr.collections-0.0.1.tar.gz", hash = "sha256:ddf38cd6379cac546ce7abdadf024fc01cca75540e11b1d5f1aa701a33817f1c"}, +] +"nr.databind.core" = [ + {file = "nr.databind.core-0.0.22-py2.py3-none-any.whl", hash = "sha256:854a0a0551a0aa5a5acedaa547af930bdaca331bc705b3f26732f6b913491572"}, + {file = "nr.databind.core-0.0.22.tar.gz", hash = "sha256:87fe32d7d8dd91b878a25cd144d056435107ca56a8db7be3030f765334075f77"}, +] +"nr.databind.json" = [ + {file = "nr.databind.json-0.0.14-py2.py3-none-any.whl", hash = "sha256:3765fd581c2ca2ee249ccfd460be0f472cc2bc9e5305e2f415d587a5e27c3b86"}, + {file = "nr.databind.json-0.0.14.tar.gz", hash = "sha256:27c7a7a69f6f703a0c616b898950fdb53a51b39cf9874d412ebc12dea574f20e"}, +] +"nr.fs" = [ + {file = "nr.fs-1.6.3-py2.py3-none-any.whl", hash = "sha256:64108c168ea2e8077fdf5f0c5417459d1a145fe34cb305fe90faeb75b4e8b421"}, + {file = "nr.fs-1.6.3.tar.gz", hash = "sha256:788aa0a04c4143f95c5245bc8ccc0c0872e932be533bd37780fbb55afcdf124a"}, +] +"nr.interface" = [ + {file = "nr.interface-0.0.4-py2.py3-none-any.whl", hash = "sha256:5f88579643ea18e1d948d92a49b326aa4585516bf64eb529ae693c4c8bddcc6e"}, + {file = "nr.interface-0.0.4.tar.gz", hash = "sha256:285cd82b932427c9d5c21cdc02ad319f701c4eed201377e2b30485c91eac67a3"}, +] +"nr.metaclass" = [ + {file = "nr.metaclass-0.0.6-py2.py3-none-any.whl", hash = "sha256:d458eb1bddd93373cc74e19981214e7d478c92c9b08fc9732bd430225698a8f0"}, + {file = "nr.metaclass-0.0.6.tar.gz", hash = "sha256:3d52f8e603e3c2944b9135e5a09593c3c36191f26cf1c29a7c71efb192552b10"}, +] +"nr.parsing.date" = [ + {file = "nr.parsing.date-0.6.0-py3-none-any.whl", hash = "sha256:ebecd847f4afe6d79b96411f7ae4765e20260dbf8eaa63d1148dcd1ee67f6616"}, + {file = "nr.parsing.date-0.6.0.tar.gz", hash = "sha256:ee952fff6c13b0f1168728b9c17b417d4d2fdb661deefadfbbf2a60ef714fce3"}, +] +"nr.pylang.utils" = [ + {file = "nr.pylang.utils-0.0.4-py3-none-any.whl", hash = "sha256:cf8c88b9e7821a256e31e83e16dcd506d1fb33ea3cf37578eb163526ab044a27"}, + {file = "nr.pylang.utils-0.0.4.tar.gz", hash = "sha256:48f81167a5f0a7376b0dd1b3db2b88ab1cfa815645a2d4048eb369564f4e2485"}, +] +"nr.stream" = [ + {file = "nr.stream-0.0.5-py2.py3-none-any.whl", hash = "sha256:cf418a4de3cedb8622286d2baca6007a153c780af48362d1f2ef2c1993525615"}, + {file = "nr.stream-0.0.5.tar.gz", hash = "sha256:3489ce5e8174b70d194a6592248ba341fbbd5bf30c9ec5f1223a351df909f505"}, +] +"nr.sumtype" = [ + {file = "nr.sumtype-0.0.4-py2.py3-none-any.whl", hash = "sha256:a1017468bbc3d187592c413892c19d0e9642bdeae0149fa0c122ca21dfb23132"}, + {file = "nr.sumtype-0.0.4.tar.gz", hash = "sha256:a224c7f70c212aebf3754cf941d94527e68f1afad8db0e224d9885eb113d797c"}, +] +"nr.utils.re" = [ + {file = "nr.utils.re-0.1.1-py2.py3-none-any.whl", hash = "sha256:eb4e6c10b074e8b296c4e2a83d0299e9a162524fb3e5e6b916dfd194688dbd06"}, + {file = "nr.utils.re-0.1.1.tar.gz", hash = "sha256:71e21300dbf890d914841f1e6d66eb4e7d6a9f01c9a20d8e83e5242c8d3140aa"}, +] numpy = [ {file = "numpy-1.19.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:cc6bd4fd593cb261332568485e20a0712883cf631f6f5e8e86a52caa8b2b50ff"}, {file = "numpy-1.19.5-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:aeb9ed923be74e659984e321f609b9ba54a48354bfd168d21a2b072ed1e833ea"}, @@ -1304,6 +1557,10 @@ pycodestyle = [ {file = "pycodestyle-2.6.0-py2.py3-none-any.whl", hash = "sha256:2295e7b2f6b5bd100585ebcb1f616591b652db8a741695b3d8f5d28bdc934367"}, {file = "pycodestyle-2.6.0.tar.gz", hash = "sha256:c58a7d2815e0e8d7972bf1803331fb0152f867bd89adf8a01dfd55085434192e"}, ] +pydoc-markdown = [ + {file = "pydoc-markdown-3.10.0.tar.gz", hash = "sha256:5076e16a14a2d708db269f6767236c2b2137e2816cf9efaba6b6bfca36367932"}, + {file = "pydoc_markdown-3.10.0-py3-none-any.whl", hash = "sha256:eccca05d136f17a1b85fc6d9fba58e5a4f134621ab0426958c79f8fc03b589ff"}, +] pydocstyle = [ {file = "pydocstyle-6.0.0-py3-none-any.whl", hash = "sha256:d4449cf16d7e6709f63192146706933c7a334af7c0f083904799ccb851c50f6d"}, {file = "pydocstyle-6.0.0.tar.gz", hash = "sha256:164befb520d851dbcf0e029681b91f4f599c62c5cd8933fd54b1bfbd50e89e1f"}, @@ -1457,8 +1714,8 @@ snowballstemmer = [ {file = "snowballstemmer-2.1.0.tar.gz", hash = "sha256:e997baa4f2e9139951b6f4c631bad912dfd3c792467e2f03d7239464af90e914"}, ] sphinx = [ - {file = "Sphinx-3.5.2-py3-none-any.whl", hash = "sha256:ef64a814576f46ec7de06adf11b433a0d6049be007fefe7fd0d183d28b581fac"}, - {file = "Sphinx-3.5.2.tar.gz", hash = "sha256:672cfcc24b6b69235c97c750cb190a44ecd72696b4452acaf75c2d9cc78ca5ff"}, + {file = "Sphinx-3.5.3-py3-none-any.whl", hash = "sha256:3f01732296465648da43dec8fb40dc451ba79eb3e2cc5c6d79005fd98197107d"}, + {file = "Sphinx-3.5.3.tar.gz", hash = "sha256:ce9c228456131bab09a3d7d10ae58474de562a6f79abb3dc811ae401cf8c1abc"}, ] sphinx-autoapi = [ {file = "sphinx-autoapi-1.7.0.tar.gz", hash = "sha256:48caa054a99c21156e9a1d26559281dc27f86ab8ef8bb6ef160f8cd9f4a0053d"}, @@ -1549,6 +1806,25 @@ vulture = [ {file = "vulture-2.3-py2.py3-none-any.whl", hash = "sha256:f39de5e6f1df1f70c3b50da54f1c8d494159e9ca3d01a9b89eac929600591703"}, {file = "vulture-2.3.tar.gz", hash = "sha256:03d5a62bcbe9ceb9a9b0575f42d71a2d414070229f2e6f95fa6e7c71aaaed967"}, ] +watchdog = [ + {file = "watchdog-1.0.2-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:e2a531e71be7b5cc3499ae2d1494d51b6a26684bcc7c3146f63c810c00e8a3cc"}, + {file = "watchdog-1.0.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e7c73edef48f4ceeebb987317a67e0080e5c9228601ff67b3c4062fa020403c7"}, + {file = "watchdog-1.0.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:85e6574395aa6c1e14e0f030d9d7f35c2340a6cf95d5671354ce876ac3ffdd4d"}, + {file = "watchdog-1.0.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:27d9b4666938d5d40afdcdf2c751781e9ce36320788b70208d0f87f7401caf93"}, + {file = "watchdog-1.0.2-pp36-pypy36_pp73-macosx_10_9_x86_64.whl", hash = "sha256:2f1ade0d0802503fda4340374d333408831cff23da66d7e711e279ba50fe6c4a"}, + {file = "watchdog-1.0.2-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:f1d0e878fd69129d0d68b87cee5d9543f20d8018e82998efb79f7e412d42154a"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_aarch64.whl", hash = "sha256:d948ad9ab9aba705f9836625b32e965b9ae607284811cd98334423f659ea537a"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_armv7l.whl", hash = "sha256:101532b8db506559e52a9b5d75a308729b3f68264d930670e6155c976d0e52a0"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_i686.whl", hash = "sha256:b1d723852ce90a14abf0ec0ca9e80689d9509ee4c9ee27163118d87b564a12ac"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_ppc64.whl", hash = "sha256:68744de2003a5ea2dfbb104f9a74192cf381334a9e2c0ed2bbe1581828d50b61"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_ppc64le.whl", hash = "sha256:602dbd9498592eacc42e0632c19781c3df1728ef9cbab555fab6778effc29eeb"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_s390x.whl", hash = "sha256:016b01495b9c55b5d4126ed8ae75d93ea0d99377084107c33162df52887cee18"}, + {file = "watchdog-1.0.2-py3-none-manylinux2014_x86_64.whl", hash = "sha256:5f1f3b65142175366ba94c64d8d4c8f4015825e0beaacee1c301823266b47b9b"}, + {file = "watchdog-1.0.2-py3-none-win32.whl", hash = "sha256:57f05e55aa603c3b053eed7e679f0a83873c540255b88d58c6223c7493833bac"}, + {file = "watchdog-1.0.2-py3-none-win_amd64.whl", hash = "sha256:f84146f7864339c8addf2c2b9903271df21d18d2c721e9a77f779493234a82b5"}, + {file = "watchdog-1.0.2-py3-none-win_ia64.whl", hash = "sha256:ee21aeebe6b3e51e4ba64564c94cee8dbe7438b9cb60f0bb350c4fa70d1b52c2"}, + {file = "watchdog-1.0.2.tar.gz", hash = "sha256:376cbc2a35c0392b0fe7ff16fbc1b303fd99d4dd9911ab5581ee9d69adc88982"}, +] wrapt = [ {file = "wrapt-1.12.1.tar.gz", hash = "sha256:b62ffa81fb85f4332a4f609cab4ac40709470da05643a082ec1eb88e6d9b97d7"}, ] diff --git a/pydoc-markdown.yml b/pydoc-markdown.yml new file mode 100644 index 0000000000000000000000000000000000000000..e37f75b08a8f1084ed025a861b13b36df2e0c762 --- /dev/null +++ b/pydoc-markdown.yml @@ -0,0 +1,44 @@ +loaders: + - type: python + packages: + - pycgtool + +processors: + - type: filter + documented_onlt: true + exclude_private: true + exclude_special: true + skip_empty_modules: true + - type: smart + - type: crossref + +renderer: + type: hugo + config: + title: PyCGTOOL + theme: { clone_url: "https://github.com/alex-shpak/hugo-book.git" } + + content_directory: content + default_preamble: { menu: main } + + pages: + - title: Home + name: index + source: README.md + + - title: Arguments + name: docs/Arguments + source: docs/arguments.md + + - title: Tutorial + name: docs/tutorial + source: docs/tutorial.md + + - title: File Formats + name: docs/file-formats + source: docs/file-formats.md + + - title: API Documentation + name: docs/api + contents: + - "*" diff --git a/pyproject.toml b/pyproject.toml index dbac21b2f67d1da7334a3975b4f352594607a93c..2964dc0769ce2117a564896eb9641e2ba833cb3d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,6 +43,7 @@ Sphinx = { version = "^3.4.3", optional = true } sphinx-autoapi = { version = "^1.5.1", optional = true } sphinx-rtd-theme = { version = "^0.5.1", optional = true } myst-parser = { version = "^0.13.5", optional = true } +pydoc-markdown = { version = "^3.10.0", optional = true } [tool.poetry.dev-dependencies] prospector = "^1.3.0" @@ -56,9 +57,10 @@ Sphinx = "^3.4.3" sphinx-autoapi = "^1.5.1" sphinx-rtd-theme = "^0.5.1" myst-parser = "^0.13.5" +pydoc-markdown = "^3.10.0" [tool.poetry.extras] -docs = ["Sphinx", "sphinx-autoapi", "sphinx-rtd-theme", "myst-parser"] +docs = ["Sphinx", "sphinx-autoapi", "sphinx-rtd-theme", "myst-parser", "pydoc-markdown"] [build-system] requires = ["poetry>=0.12"]