encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-26 03:23:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Adding a docs env to the tox project.

Browse Source 
This will run the linkcheck and build the html docs, turning any warnings into
errors.
Also changed the theme to sphinx-doc and added version to be displayed in the
docs.
This commit is contained in:
Marko Tibold 2011-12-15 00:27:29 +01:00
parent 8cabab2703
commit e2b9359a2d
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/check_sphinx.py Normal file
View File

@ -0,0 +1,16 @@
import pytest
import subprocess
def test_linkcheck(tmpdir):
doctrees = tmpdir.join("doctrees")
htmldir = tmpdir.join("html")
subprocess.check_call(
["sphinx-build", "-W", "-blinkcheck",
"-d", str(doctrees), ".", str(htmldir)])
def test_build_docs(tmpdir):
doctrees = tmpdir.join("doctrees")
htmldir = tmpdir.join("html")
subprocess.check_call([
"sphinx-build", "-W", "-bhtml",
"-d", str(doctrees), ".", str(htmldir)])