Skip to content

Add docs building to tox.ini #562

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

Merged
merged 2 commits into from
Jul 9, 2020
Merged

Add docs building to tox.ini #562

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
3ee9e7f
Add docs building to tox.ini
sfdye Jun 13, 2020
e55f915
Add initial contributing guide with docs build instruction
sfdye Jun 13, 2020
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
8 changes: 8 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributing

## Build documentation locally

Using tox:
```shell
$ tox -e docs
```
1 change: 0 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@

from __future__ import absolute_import, print_function
import sys, os
from future import __version__
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused import

import sphinx_bootstrap_theme

# If extensions (or modules to document with autodoc) are in another directory,
Expand Down
10 changes: 9 additions & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
[tox]
envlist = py26,py27,py33,py34,py35,py36,py37
envlist =
py{26,27,33,34,35,36,37},
docs

[testenv]
deps =
pytest
unittest2
py26: importlib
commands = pytest {posargs}

[testenv:docs]
deps =
sphinx
sphinx_bootstrap_theme
commands = sphinx-build docs build