diff options
| -rw-r--r-- | docs/conf.py | 10 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/templates/layout.html | 3 | ||||
| -rw-r--r-- | tox.ini | 90 |
4 files changed, 60 insertions, 44 deletions
diff --git a/docs/conf.py b/docs/conf.py index 503b4059..0a9fe068 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,9 +55,13 @@ copyright = u'2011, Tom Christie' # built documents. # # The short X.Y version. -version = '0.1' + +import djangorestframework + +version = djangorestframework.__version__ + # The full version, including alpha/beta/rc tags. -release = '0.1' +release = version autodoc_member_order='bysource' @@ -100,7 +104,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinxdoc' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/index.rst b/docs/index.rst index 309effab..6038b7df 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,7 +45,6 @@ Requirements Installation ------------ - You can install Django REST framework using ``pip`` or ``easy_install``:: pip install djangorestframework diff --git a/docs/templates/layout.html b/docs/templates/layout.html index 6ba9e6ff..70532554 100644 --- a/docs/templates/layout.html +++ b/docs/templates/layout.html @@ -23,4 +23,5 @@ })(); </script> -{% endblock %} +{% endblock %}{% block footer %} +<div class="footer"> <p> Documentation version {{ version }} {% endblock %}</p></div> @@ -37,7 +37,7 @@ deps= django==1.2.4 coverage==3.4 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py27-django12] basepython=python2.7 @@ -45,7 +45,7 @@ deps= django==1.2.4 coverage==3.4 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py25-django13] basepython=python2.5 @@ -53,23 +53,23 @@ deps= django==1.3 coverage==3.4 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py26-django13] basepython=python2.6 deps= django==1.3 coverage==3.4 - unittest-xml-reporting==1.2 - Pyyaml==3.10 + unittest-xml-reporting==1.2 + Pyyaml==3.10 [testenv:py27-django13] basepython=python2.7 deps= django==1.3 coverage==3.4 - unittest-xml-reporting==1.2 - Pyyaml==3.10 + unittest-xml-reporting==1.2 + Pyyaml==3.10 ####################################### EXAMPLES ################################################ @@ -80,12 +80,12 @@ commands= deps= django==1.2.4 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py26-django12e] basepython=python2.6 @@ -94,12 +94,12 @@ commands= deps= django==1.2.4 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py27-django12e] basepython=python2.7 @@ -108,12 +108,12 @@ commands= deps= django==1.2.4 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py25-django13e] basepython=python2.5 @@ -122,12 +122,12 @@ commands= deps= django==1.3 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 unittest-xml-reporting==1.2 - Pyyaml==3.10 + Pyyaml==3.10 [testenv:py26-django13e] basepython=python2.6 @@ -136,12 +136,12 @@ commands= deps= django==1.3 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 - unittest-xml-reporting==1.2 - Pyyaml==3.10 + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 + unittest-xml-reporting==1.2 + Pyyaml==3.10 [testenv:py27-django13e] basepython=python2.7 @@ -150,9 +150,21 @@ commands= deps= django==1.3 coverage==3.4 - wsgiref==0.1.2 - Pygments==1.4 - httplib2==0.6.0 - Markdown==2.0.3 - unittest-xml-reporting==1.2 - Pyyaml==3.10
\ No newline at end of file + wsgiref==0.1.2 + Pygments==1.4 + httplib2==0.6.0 + Markdown==2.0.3 + unittest-xml-reporting==1.2 + Pyyaml==3.10 + +##########################################DOCS################################################# + +[testenv:docs] +basepython=python +changedir=docs +deps= + sphinx + pytest + django==1.3 +commands= + py.test --tb=line -v --junitxml=junit-{envname}.xml check_sphinx.py |