Fix sphinx build (#392)

Also add extra step in build pipeline to avoid future errors.
aio-libs · Apr 3, 2018 · 1bbf3de · 1bbf3de
1 parent c0186d0
commit 1bbf3de
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 24 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -23,6 +23,8 @@ matrix:
 
     - python: 3.6
       env: TOXENV=syntax
+    - python: 3.6
+      env: TOXENV=docs-html
 
 install:
   - pip install tox

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -5,5 +5,5 @@ Contributing
 #. Install dependencies with ``make install-dev`` (you will need ``pipenv`` which you can install with ``pip install pipenv``)
 #. Make a change (means writing code, tests without reducing coverage and docs)
 #. Ensure all tests pass with ``make test``. For fast iterations, use ``make unit`` which will build just the unit tests. You will need docker and docker-compose to be able to pass acceptance and functional tests.
-#. Ensure documentation is OK with ``sphinx-autobuild docs/ docs/_build/html/``
+#. Ensure documentation is OK with ``pipenv run sphinx-autobuild docs/ docs/_build/html/``
 #. Make the PR in Github (you must have a fork of your own)
diff --git a/Makefile b/Makefile
@@ -21,7 +21,7 @@ acceptance:
 	pipenv run pytest -sv tests/acceptance
 
 doc:
-	make -C docs/ html
+	pipenv run make -C docs/ html
 
 functional:
 	pipenv run bash examples/run_all.sh

diff --git a/docs/conda_environment.yml b/docs/conda_environment.yml
diff --git a/docs/readthedocs.yml b/docs/readthedocs.yml
@@ -1,2 +1,13 @@
-conda:
-    file: conda_environment.yml
+formats:
+  - none
+
+build:
+  image: latest
+
+python:
+  version: 3.6
+  pip_install: true
+  extra_requirements:
+    - redis
+    - memcached
+    - msgpack
diff --git a/docs/serializers.rst b/docs/serializers.rst
@@ -48,10 +48,10 @@ JsonSerializer
 
 ..  _msgpackserializer:
 
-MessagePackSerializer
---------------
+MsgPackSerializer
+-----------------
 
-.. autoclass:: aiocache.serializers.MessagePackSerializer
+.. autoclass:: aiocache.serializers.MsgPackSerializer
   :members:
 
 In case the current serializers are not covering your needs, you can always define your custom serializer as shown in ``examples/serializer_class.py``:

diff --git a/tox.ini b/tox.ini
@@ -2,6 +2,9 @@
 envlist =
   py{36}-{deps-lowest,deps-devel}
   py{35,36}-ujson
+  codecov
+  syntax
+  docs-html
 
 
 [testenv]
@@ -44,3 +47,12 @@ commands =
   coverage combine
   coverage report
   codecov
+
+
+[testenv:docs-html]
+deps =
+  .[redis]
+  .[memcached]
+  .[msgpack]
+  .[dev]
+commands = sphinx-build -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html