Skip to content

Commit

Permalink
Merge pull request #153 from alandtse/sphinx
Browse files Browse the repository at this point in the history
Signed-off-by: Alan Tse <alandtse@gmail.com>
  • Loading branch information
alandtse committed Feb 15, 2021
2 parents b26c5d9 + fd67179 commit 1432c04
Show file tree
Hide file tree
Showing 5 changed files with 157 additions and 8 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@ test:
typing:
pipenv run mypy --ignore-missing-imports teslajsonpy
docs: docstyle
pipenv lock -r --dev > docs/requirements.txt
echo "teslajsonpy" >> docs/requirements.txt
pipenv run sphinx-build -b html docs docs/html
2 changes: 2 additions & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ sphinx = "*"
autoapi = "*"
sphinx-rtd-theme = "*"
m2r2 = "*"
sphinx-autoapi = "*"
sphinx-copybutton = "*"

[packages]
aiohttp = "*"
Expand Down
50 changes: 49 additions & 1 deletion Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified docs/html/.doctrees/environment.pickle
Binary file not shown.
111 changes: 104 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,104 @@
sphinx >=3.0,<4.0
sphinx-rtd-theme >=0.5,<1.0
sphinx-autoapi >=1.5,<2.0
sphinx-copybutton >=0.3,<1.0
tomlkit >=0.7,<1.0
m2r2 >=0.2.7,<1.0.0
autoapi >=2.0.1,<3.0.0
#
# These requirements were autogenerated by pipenv
# To regenerate from the project's Pipfile, run:
#
# pipenv lock --requirements --dev
#

# 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
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'
colorama==0.4.4; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
coverage==5.4; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4.0'
detox==0.19
distlib==0.3.1
dnspython==1.16.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
docutils==0.16; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
eventlet==0.30.1
filelock==3.0.12
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'
keyring==22.0.1; python_version >= '3.6'
lazy-object-proxy==1.4.3; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
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'
pathspec==0.8.1
pipenv==2020.11.15; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
pkginfo==1.7.0
pluggy==0.13.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
py==1.10.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
pycodestyle==2.6.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
pydocstyle==5.1.1
pyflakes==2.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
pygments==2.8.0; python_version >= '3.5'
pylint==2.6.0
pyparsing==2.4.7; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
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
requests==2.25.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
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'
sphinxcontrib-devhelp==1.0.2; python_version >= '3.5'
sphinxcontrib-htmlhelp==1.0.3; python_version >= '3.5'
sphinxcontrib-jsmath==1.0.1; python_version >= '3.5'
sphinxcontrib-qthelp==1.0.3; python_version >= '3.5'
sphinxcontrib-serializinghtml==1.1.4; python_version >= '3.5'
toml==0.10.2; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
tox-pipenv==1.10.1
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

0 comments on commit 1432c04

Please sign in to comment.