From 5bc41e1afa9774aa5a381341919a0ccc29e8f420 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Sun, 2 Aug 2020 19:40:21 +0300 Subject: [PATCH] Add config for Read the Docs --- .readthedocs.yml | 2 ++ README.md | 1 + docs/requirements.txt | 3 +++ mkdocs.yml | 2 +- tox.ini | 5 +---- 5 files changed, 8 insertions(+), 5 deletions(-) create mode 100644 .readthedocs.yml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..6006faad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,2 @@ +python: + install: true diff --git a/README.md b/README.md index 24db5e19..e5a0b2ca 100644 --- 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 new file mode 100644 index 00000000..752ae7b0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +mkdocs>=1.1 +mkdocs-material +mkdocstrings diff --git a/mkdocs.yml b/mkdocs.yml index 3fe86931..f515aa86 100644 --- 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 index 622fe926..169125c5 100644 --- 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]