Skip to content

Commit c049837

Browse files
committed
Update docs for running doctests locally
1 parent 9e4b11a commit c049837

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

travis/docker/Makefile

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
ROOT = $(shell git rev-parse --show-toplevel)
22
$(shell reset)
33

4+
all: doctest3
5+
46
Dockerfile: FORCE
57
cp $(ROOT)/extra/docker/develop/Dockerfile Dockerfile
68
cat Dockerfile.travis >> Dockerfile
79
cp $(ROOT)/extra/docker/develop/10-import.py 10-import.py
810
cp $(ROOT)/extra/docker/develop/ipython_config.py ipython_config.py
911

10-
all: doctest3
1112

1213
shell bash: image
1314
@echo Running interactive shell
@@ -30,4 +31,4 @@ image: Dockerfile
3031
docker build -t travis .
3132

3233
FORCE:
33-
.PHONY: all image doctest bash
34+
.PHONY: all image doctest2 doctest3 bash

travis/docker/README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ It's pretty simple, just run `make`. All of your changes will be copied into th
66

77
```shell
88
$ make -C travis/docker ANDROID=yes
9-
$ make -C travis/docker ANDROID=no TARGET=docs/source/tubes/ssh.rst
9+
$ make -C travis/docker ANDROID=no TARGET=ssh.rst
10+
```
11+
12+
By default the Python 3 tests are run. You can choose the Python version using the `doctest2` or `doctest3` target.
13+
14+
```shell
15+
$ make -C travis/docker ANDROID=no doctest2
16+
```
17+
18+
You can get drop into a tmux session in the container to debug tests using the `shell` or `bash` targets.
19+
20+
```shell
21+
$ make -C travis/docker shell
1022
```
1123

1224
## Options
@@ -19,7 +31,7 @@ Controls whether or not to run the Android test. The valid options are ``yes``
1931

2032
### `TARGET`
2133

22-
This is appended to the `sphinx` command line, but generally is useful to sepcify a specific `rst` file to parse (e.g. to only run those tests).
34+
This is appended to the `sphinx` command line, but generally is useful to select a specific `rst` file to parse (e.g. to only run those tests).
2335

2436
## Known Issues
2537

travis/docker/tmux.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
#!/usr/bin/env zsh
2-
exec tmux -u -2 -CC
2+
exec tmux -u -2

0 commit comments

Comments
 (0)