Merge pull request #148 from hugovk/rtd

Deploy docs to Read the Docs
jmoiron · Aug 2, 2020 · 30fa839 · 30fa839
2 parents 5df1fc1 + 5bc41e1
commit 30fa839
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,2 @@
+python:
+    install: true
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![PyPI version](https://img.shields.io/pypi/v/humanize.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/humanize/)
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/humanize.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/humanize/)
+[![Documentation Status](https://readthedocs.org/projects/python-humanize/badge/?version=latest)](https://python-humanize.readthedocs.io/en/latest/?badge=latest)
 [![PyPI downloads](https://img.shields.io/pypi/dm/humanize.svg)](https://pypistats.org/packages/humanize)
 [![Travis CI Status](https://travis-ci.com/hugovk/humanize.svg?branch=master)](https://travis-ci.com/hugovk/humanize)
 [![GitHub Actions status](https://github.com/jmoiron/humanize/workflows/Test/badge.svg)](https://github.com/jmoiron/humanize/actions)

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs>=1.1
+mkdocs-material
+mkdocstrings
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,5 @@
 site_name: humanize
-site_url: https://example.com/docs/TODO
+site_url: https://python-humanize.readthedocs.io
 repo_url: https://github.com/jmoiron/humanize
 theme:
   name: "material"

diff --git a/tox.ini b/tox.ini
@@ -9,10 +9,7 @@ commands =
     {envpython} -m pytest --cov humanize --cov tests --cov-report xml {posargs}
 
 [testenv:docs]
-deps =
-    mkdocs
-    mkdocs-material
-    mkdocstrings
+deps = -r docs/requirements.txt
 commands = mkdocs build
 
 [testenv:lint]