Skip to content

Commit 3ea45d1

Browse files
committed
refactor readme files: in conda tests
1 parent 6e89647 commit 3ea45d1

File tree

6 files changed

+19
-13
lines changed

6 files changed

+19
-13
lines changed

tests/conda/README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# Overview of tests for the conda buildpack
22

3-
## py2
3+
## Tested configuration files
4+
5+
- [`.binder/`](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
6+
- [`requirements.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#requirements-txt-install-a-python-environment)
7+
- [`postBuild](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
8+
9+
## Tested repo2docker command line flags
10+
11+
- [`--target-repo-dir`](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
12+
13+
### py2
414

515
- Test setup of a Python 2 environment by declaring `python=2` in
616
`environment.yml`.
717

8-
## py35-binder-dir
18+
### py35-binder-dir
919

1020
- Test setup of a Python 3.5 environment by declaring `python=3.5` in
1121
`environment.yml`.
@@ -14,11 +24,9 @@
1424
Python 3 supported by repo2docker's conda buildpack. See
1525
`repo2docker/buildpacks/conda` for details.
1626

17-
- Test use of a `.binder` directory, where files outside it shouldn't be
18-
considered. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
19-
for details.
27+
- Test use of a `.binder` directory.
2028

21-
## py310-requirements-file
29+
### py310-requirements-file
2230

2331
- Test setup of a Python 3.10 environment by declaring `python=3.10` in
2432
`environment.yml`.
@@ -30,24 +38,22 @@
3038
- Test use of a `requirements.txt` file, where an `environment.yml` file should
3139
take precedence and the `requirements.txt` should be ignored.
3240

33-
## r-postbuild-file
41+
### py-r-postbuild-file
3442

3543
- Test setup of the default Python environment by omitting `python` from
3644
`environment.yml` file.
3745

3846
- Test setup of the default R environment by specifying `r-base` in
3947
`environment.yml`.
4048

41-
- Test use of a `postBuild` file. See [this documentation](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
42-
for details.
49+
- Test use of a `postBuild` file.
4350

44-
## r3.6-target-repo-dir-flag
51+
### r3.6-target-repo-dir-flag
4552

4653
- Test setup of a R 3.6 environment by specifying `r-base=3.6` in
4754
`environment.yml`.
4855

49-
- Test use of repo2docker with the `--target-repo-dir` flag. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
50-
for details.
56+
- Test use of repo2docker with the `--target-repo-dir` flag.
5157

5258
`--target-repo-dir` is meant to support custom paths where repositories can be
5359
copied to besides `${HOME}`.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# This file is respected by repo2docker's test suite, but not repo2docker
2-
# itself. It is used solely to help us test command line flags.
2+
# itself. It is used solely to help us test repo2docker's command line flags.
33
#
44
- --target-repo-dir=/srv/repo

0 commit comments

Comments
 (0)