diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..f02a7c2b --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,17 @@ +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +# Optionally set the version of Python and requirements required to build your docs +python: + version: 3.7 + install: + - requirements: requirements-docs.txt + - method: pip + path: . \ No newline at end of file diff --git a/README.rst b/README.rst index 46049616..5d72c3d1 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,8 @@ bimmer_connected :target: https://pepy.tech/project/bimmer-connected .. image:: https://travis-ci.org/bimmerconnected/bimmer_connected.svg?branch=master :target: https://travis-ci.org/bimmerconnected/bimmer_connected +.. image:: https://readthedocs.org/projects/bimmer-connected/badge/?version=latest + :target: https://bimmer-connected.readthedocs.io/en/latest/?badge=latest .. image:: https://coveralls.io/repos/github/bimmerconnected/bimmer_connected/badge.svg?branch=master :target: https://coveralls.io/github/bimmerconnected/bimmer_connected?branch=master diff --git a/readthedocs.yml b/readthedocs.yml deleted file mode 100644 index 248d9c29..00000000 --- a/readthedocs.yml +++ /dev/null @@ -1,3 +0,0 @@ -python: - version: 3.5 - pip_install: true \ No newline at end of file diff --git a/requirements-docs.txt b/requirements-docs.txt new file mode 100644 index 00000000..bfe8df81 --- /dev/null +++ b/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-autobuild +sphinx_rtd_theme +sphinx-argparse +pbr diff --git a/requirements-test.txt b/requirements-test.txt index 0a339e9d..5d65a9a5 100644 --- a/requirements-test.txt +++ b/requirements-test.txt @@ -3,8 +3,4 @@ pytest-cov pytest-timeout pylint flake8 -sphinx -sphinx-autobuild -sphinx_rtd_theme -sphinx-argparse pbr diff --git a/tox.ini b/tox.ini index 905c6453..17d70b75 100644 --- a/tox.ini +++ b/tox.ini @@ -6,6 +6,7 @@ skip_missing_interpreters = True deps = -rrequirements.txt -rrequirements-test.txt + -rrequirements-docs.txt passenv = TRAVIS TRAVIS_* commands = pytest --cov=bimmer_connected --timeout=10 test