openstack/deb-python-ddt
Code Issues Proposed changes

Update docs to not keep track of example test output

Browse Source
This commit is contained in:
Carles Barrobés
2014-02-09 00:17:40 +01:00
parent 42e5d1f8ad
commit d1f962a18b
3 changed files with 8 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc-requirements.txt
View File

@@ -1 +1,2 @@
Sphinx
sphinxcontrib-programoutput

2
docs/conf.py
View File

@@ -31,6 +31,8 @@ sys.path.insert(0, os.path.split(docs_root)[0])
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc']
if not on_rtd:
extensions.append('sphinxcontrib.programoutput')
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

28
docs/example.rst
View File

@@ -22,30 +22,12 @@ and ``test_data_list.json``:
.. literalinclude:: ../test/test_data_list.json
:language: javascript
And then run them with::
And then run them with your favourite test runner, e.g. if you use nose::
$ nosetests -v test/test_example.py
test_file_data_dict_sorted_list (test.test_example.FooTestCase) ... ok
test_file_data_dict_unsorted_list (test.test_example.FooTestCase) ... ok
test_file_data_list_Goodbye (test.test_example.FooTestCase) ... ok
test_file_data_list_Hello (test.test_example.FooTestCase) ... ok
test_greater_test_10_greater_than_5 (test.test_example.FooTestCase) ... ok
test_greater_test_2_greater_than_1 (test.test_example.FooTestCase) ... ok
test_larger_than_two_12 (test.test_example.FooTestCase) ... ok
test_larger_than_two_23 (test.test_example.FooTestCase) ... ok
test_larger_than_two_3 (test.test_example.FooTestCase) ... ok
test_larger_than_two_4 (test.test_example.FooTestCase) ... ok
test_not_larger_than_two_-3 (test.test_example.FooTestCase) ... ok
test_not_larger_than_two_0 (test.test_example.FooTestCase) ... ok
test_not_larger_than_two_1 (test.test_example.FooTestCase) ... ok
test_not_larger_than_two_2 (test.test_example.FooTestCase) ... ok
test_undecorated (test.test_example.FooTestCase) ... ok
test_unicode_ascii (test.test_example.FooTestCase) ... ok
test_unicode_non-ascii-\u2603 (test.test_example.FooTestCase) ... ok
----------------------------------------------------------------------
Ran 17 tests in 0.002s
..
program-output:: nosetests -v ../test/test_example.py
OK
7 test methods + some *magic* decorators = 17 test cases.
The number of test cases actually run and reported separately has been
multiplied.