diff --git a/Makefile b/Makefile index 5ebae566..18cd38ab 100644 --- a/Makefile +++ b/Makefile @@ -26,6 +26,6 @@ test: typing: pipenv run mypy --ignore-missing-imports teslajsonpy docs: docstyle - pipenv lock -r > docs/requirements.txt - pipenv lock -r --dev-only >> docs/requirements.txt + pipenv lock -r --dev > docs/requirements.txt + echo "teslajsonpy" >> docs/requirements.txt pipenv run sphinx-build -b html docs docs/html \ No newline at end of file diff --git a/Pipfile b/Pipfile index fcc3c2c9..8ac2afb2 100644 --- a/Pipfile +++ b/Pipfile @@ -20,6 +20,8 @@ sphinx = "*" autoapi = "*" sphinx-rtd-theme = "*" m2r2 = "*" +sphinx-autoapi = "*" +sphinx-copybutton = "*" [packages] aiohttp = "*" diff --git a/Pipfile.lock b/Pipfile.lock index a2b7c735..d0c6726f 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "09f91c901a646f5ad0f6d7530e821cc133df44f2a0d3906f25c27de221e7e44a" + "sha256": "728a505481abdfd0b16ab2b017cf5954542a93553560275b9480d0eec2c0213b" }, "pipfile-spec": 6, "requires": {}, @@ -800,6 +800,33 @@ ], "version": "==2021.1" }, + "pyyaml": { + "hashes": [ + "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf", + "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696", + "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393", + "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77", + "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922", + "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5", + "sha256:4465124ef1b18d9ace298060f4eccc64b0850899ac4ac53294547536533800c8", + "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10", + "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc", + "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018", + "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e", + "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253", + "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183", + "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb", + "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185", + "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db", + "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46", + "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b", + "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63", + "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df", + "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5'", + "version": "==5.4.1" + }, "readme-renderer": { "hashes": [ "sha256:267854ac3b1530633c2394ead828afcd060fc273217c42ac36b6be9c42cd9a9d", @@ -897,6 +924,20 @@ ], "version": "==3.5.0" }, + "sphinx-autoapi": { + "hashes": [ + "sha256:48caa054a99c21156e9a1d26559281dc27f86ab8ef8bb6ef160f8cd9f4a0053d", + "sha256:cb0245fc989fa1ec7cb4ddd8a41ff2cc8b0e8a9d12f4c366ad0eac059eb81c2c" + ], + "version": "==1.7.0" + }, + "sphinx-copybutton": { + "hashes": [ + "sha256:0e0461df394515284e3907e3f418a0c60ef6ab6c9a27a800c8552772d0a402a2", + "sha256:5125c718e763596e6e52d92e15ee0d6f4800ad3817939be6dee51218870b3e3d" + ], + "version": "==0.3.1" + }, "sphinx-rtd-theme": { "hashes": [ "sha256:eda689eda0c7301a80cf122dad28b1861e5605cbf455558f3775e1e8200e83a5", @@ -1032,6 +1073,13 @@ ], "version": "==3.7.4.3" }, + "unidecode": { + "hashes": [ + "sha256:12435ef2fc4cdfd9cf1035a1db7e98b6b047fe591892e81f34e94959591fad00", + "sha256:8d73a97d387a956922344f6b74243c2c6771594659778744b2dbdaad8f6b727d" + ], + "version": "==1.2.0" + }, "urllib3": { "hashes": [ "sha256:1b465e494e3e0d8939b50680403e3aedaa2bc434b7d5af64dfd3c958d7f5ae80", diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle index bbce19f4..df5322e1 100644 Binary files a/docs/html/.doctrees/environment.pickle and b/docs/html/.doctrees/environment.pickle differ diff --git a/docs/requirements.txt b/docs/requirements.txt index fc99ab53..04b1183b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,41 +2,24 @@ # These requirements were autogenerated by pipenv # To regenerate from the project's Pipfile, run: # -# pipenv lock --requirements +# pipenv lock --requirements --dev # --i https://pypi.python.org/simple -aiohttp==3.7.3 -async-timeout==3.0.1; python_full_version >= '3.5.3' -attrs==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' -authcaptureproxy==0.4.1 -backoff==1.10.0 -beautifulsoup4==4.9.3 -chardet==3.0.4 -click==7.1.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' -idna==3.1; python_version >= '3.4' -importlib-metadata==3.4.0; python_version >= '3.6' -multidict==5.1.0; python_version >= '3.6' -soupsieve==2.2; python_version >= '3.0' -typer==0.3.2; python_version >= '3.6' -typing-extensions==3.7.4.3 -wrapt==1.12.1 -yarl==1.6.3; python_version >= '3.6' -zipp==3.4.0; python_version >= '3.6' -# -# These requirements were autogenerated by pipenv -# To regenerate from the project's Pipfile, run: -# -# pipenv lock --requirements --dev-only -# +# Note: in pipenv 2020.x, "--dev" changed to emit both default and development +# requirements. To emit only development requirements, pass "--dev-only". -i https://pypi.python.org/simple +aiohttp==3.7.3 alabaster==0.7.12 appdirs==1.4.4 astroid==2.4.2; python_version >= '3.5' +async-timeout==3.0.1; python_full_version >= '3.5.3' attrs==20.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' +authcaptureproxy==0.4.1 autoapi==2.0.1 babel==2.9.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' +backoff==1.10.0 +beautifulsoup4==4.9.3 black==20.8b1 bleach==3.3.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' certifi==2020.12.5 @@ -54,6 +37,7 @@ flake8==3.8.4 greenlet==1.0.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' idna==3.1; python_version >= '3.4' imagesize==1.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' +importlib-metadata==3.4.0; python_version >= '3.6' iniconfig==1.1.1 isort==5.7.0; python_version >= '3.6' and python_version < '4.0' jinja2==2.11.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' @@ -63,6 +47,7 @@ m2r2==0.2.7 markupsafe==1.1.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' mccabe==0.6.1 mistune==0.8.4 +multidict==5.1.0; python_version >= '3.6' mypy-extensions==0.4.3 mypy==0.800 packaging==20.9; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' @@ -81,6 +66,7 @@ pytest-asyncio==0.14.0 pytest-cov==2.11.1 pytest==6.2.2 pytz==2021.1 +pyyaml==5.4.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4, 3.5' readme-renderer==28.0 regex==2020.11.13 requests-toolbelt==0.9.1 @@ -88,6 +74,9 @@ requests==2.25.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3 rfc3986==1.4.0 six==1.15.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' snowballstemmer==2.1.0 +soupsieve==2.2; python_version >= '3.0' +sphinx-autoapi==1.7.0 +sphinx-copybutton==0.3.1 sphinx-rtd-theme==0.5.1 sphinx==3.5.0 sphinxcontrib-applehelp==1.0.2; python_version >= '3.5' @@ -102,9 +91,14 @@ tox==3.6.1 tqdm==4.56.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' twine==3.3.0 typed-ast==1.4.2 +typer==0.3.2; python_version >= '3.6' typing-extensions==3.7.4.3 +unidecode==1.2.0 urllib3==1.26.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4.0' virtualenv-clone==0.5.4; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' virtualenv==20.4.2; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3' webencodings==0.5.1 wrapt==1.12.1 +yarl==1.6.3; python_version >= '3.6' +zipp==3.4.0; python_version >= '3.6' +teslajsonpy