Fix building on readthedocs.io (#179)

bimmerconnected · Apr 25, 2020 · 6bae2f5 · 6bae2f5
1 parent 457770b
commit 6bae2f5
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 7 deletions.
diff --git a/.readthedocs.yml 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: .
diff --git 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
diff --git a/requirements-docs.txt 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
@@ -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
@@ -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