From 3ee9e7ffeec7fabed672e2240eac9eca318e4438 Mon Sep 17 00:00:00 2001 From: Liuyang Wan Date: Sat, 13 Jun 2020 10:03:05 +0800 Subject: [PATCH 1/2] Add docs building to tox.ini --- docs/conf.py | 1 - tox.ini | 10 +++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fd106fa0..6f00536b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,7 +13,6 @@ from __future__ import absolute_import, print_function import sys, os -from future import __version__ import sphinx_bootstrap_theme # If extensions (or modules to document with autodoc) are in another directory, diff --git a/tox.ini b/tox.ini index f5c013f8..1ca3286b 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,7 @@ [tox] -envlist = py26,py27,py33,py34,py35,py36,py37 +envlist = + py{26,27,33,34,35,36,37}, + docs [testenv] deps = @@ -7,3 +9,9 @@ deps = unittest2 py26: importlib commands = pytest {posargs} + +[testenv:docs] +deps = + sphinx + sphinx_bootstrap_theme +commands = sphinx-build docs build From e55f91595c88a528e2b305cf67e7d892e58fafdb Mon Sep 17 00:00:00 2001 From: Liuyang Wan Date: Sat, 13 Jun 2020 10:11:31 +0800 Subject: [PATCH 2/2] Add initial contributing guide with docs build instruction --- .github/CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..f8a20eda --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,8 @@ +# Contributing + +## Build documentation locally + +Using tox: +```shell +$ tox -e docs +```