Added docs build tox testenv

madnesspie · Apr 27, 2020 · 7663084 · 7663084
1 parent 4910d78
commit 7663084
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/AUTHORS.rst b/AUTHORS.rst
@@ -7,7 +7,7 @@ Maintainers
 - `Alexander Polishchuk <https://github.com/madnesspie>`_
 
 
-Cuntributors
+Contributors
 ------------
 
-- `Evgeny Yachmenev <https://www.behance.net/yes_dez>`_
+- `Evgeny Yachmenev <https://www.behance.net/yes_dez>`_ (logo)
diff --git a/setup.py b/setup.py
@@ -40,8 +40,8 @@ def read(file_name):
     extras_require=EXTRAS_REQUIRE,
     license="GNU Lesser General Public License v3 or later (LGPLv3+)",
     description="Async blockchain nodes interacting tool with ORM-like api.",
-    long_description=read("README.md"),
-    long_description_content_type="text/markdown",
+    long_description=read("README.rst"),
+    long_description_content_type="text/x-rst",
     url="https://github.com/madnesspie/obm",
     author="Alexander Polishchuk",
     author_email="apolishchuk52@gmail.com",

diff --git a/tox.ini b/tox.ini
@@ -7,6 +7,7 @@
 envlist =
     py38
     lint
+    docs
 
 [testenv]
 extras = tests
@@ -18,6 +19,10 @@ commands =
     pylint obm -d C
     pylint tests -d C,import-error
 
+[testenv:docs]
+extras = docs
+commands = sphinx-build docs/ docs/_build
+
 ; Below tasks are for development only (not run in CI)
 
 [testenv:watch-docs]