File tree Expand file tree Collapse file tree 4 files changed +22
-12
lines changed Expand file tree Collapse file tree 4 files changed +22
-12
lines changed Original file line number Diff line number Diff line change @@ -22,4 +22,4 @@ deploy:
22
22
local-dir : .tox/docs/_build
23
23
on :
24
24
tags : true
25
- condition : $TOX = docs
25
+ condition : $TOX = " docs"
Original file line number Diff line number Diff line change 1
1
.. include :: ../README.rst
2
2
3
- Content
4
- -------
5
-
6
3
.. testsetup ::
7
4
8
5
from foo import foo
9
6
7
+ Doctest in the documentation
8
+ ----------------------------
9
+
10
+ >>> foo(' dummy' )
11
+ 'foo'
12
+
13
+
14
+ Content
15
+ -------
16
+
17
+
10
18
.. automodule :: foo
11
19
:members:
12
20
:show-inheritance:
Original file line number Diff line number Diff line change @@ -11,8 +11,8 @@ def foo(dummy):
11
11
Examples should be written in doctest format, and should illustrate how
12
12
to use the function.
13
13
14
- >>> print( foo('dummy') )
15
- foo
14
+ >>> foo('dummy')
15
+ ' foo'
16
16
17
17
Note:
18
18
Test note in docstring
Original file line number Diff line number Diff line change @@ -15,17 +15,19 @@ deps =
15
15
-rrequirements.txt
16
16
-rtests/requirements.txt
17
17
18
- commands =
19
- py.test --verbose \
20
- --cov {envsitepackagesdir}/foo --cov-report term-missing --cov-report html \
18
+ commands =
19
+ py.test \
20
+ --cov {envsitepackagesdir}/foo \
21
+ --cov-report term-missing \
22
+ --verbose \
21
23
{posargs}
22
24
23
25
[testenv:py36-docs]
24
26
deps =
25
27
-rdocs/requirements.txt
26
28
27
- commands =
29
+ commands =
30
+ sphinx-build docs " {toxworkdir}/docs/_build" --color -W -bhtml {posargs}
28
31
sphinx-build docs " {toxworkdir}/docs/_build" --color -W -bdoctest {posargs}
29
32
sphinx-build docs " {toxworkdir}/docs/_build" --color -W -bcoverage {posargs}
30
- /bin/cat {toxworkdir}/docs/_build/python.txt
31
- sphinx-build docs " {toxworkdir}/docs/_build" --color -W -bhtml {posargs}
33
+ /bin/cat {toxworkdir}/docs/_build/python.txt
You can’t perform that action at this time.
0 commit comments