Skip to content

Add a tox environment for building documentation #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add a tox environment for building documentation #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85bc9d5
Add a docs testenv
lvh Jun 23, 2014
03afe12
Add the _STATIC directory
lvh Jun 23, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/_static/README
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This README file is just to populate the _static directory it lives
in.

This is necessary because:

- Sphinx wants to see the _static directory.
- Git doesn't want to put empty directories under source control.

Otherwise, this file serves no purpose.
9 changes: 8 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = pypy,py26,py27,py32,py33
envlist = pypy,py26,py27,py32,py33,docs

[testenv]
setenv =
Expand All @@ -8,3 +8,10 @@ setenv =
PYTHONPATH=
# The standard library unittest module can run tests on Python 2.7 and newer
commands = python setup.py test

[testenv:docs]
deps =
sphinx==1.2.2
basepython = python2.7
commands =
sphinx-build -W -b html doc doc/_build/html