reorder config files into rough order of build precedence

pull/262/head
Carol Willing 2018-03-15 07:07:20 -07:00
rodzic 05168b037b
commit ae6cdca424
1 zmienionych plików z 38 dodań i 37 usunięć

Wyświetl plik

@ -9,17 +9,14 @@ Below is a list of supported configuration files.
:local:
:depth: 1
``requirements.txt``
^^^^^^^^^^^^^^^^^^^^
``Dockerfile``
^^^^^^^^^^^^^^
This specifies a list of python packages that would be installed in a virtualenv (or conda environment).
Example Contents
````````````````
::
numpy==1.7
matplotlib==2.1
This will be treated as a regular Dockerfile and a regular Docker build will be performed.
The presence of a Dockerfile takes priority over and ignores all other build behavior
specified in other configuration files.
See the `Binder Documentation <https://mybinder.readthedocs.io/en/latest/dockerfile.html>`_ for
best-practices with Dockerfiles.
``environment.yml``
^^^^^^^^^^^^^^^^^^^
@ -43,11 +40,40 @@ Example Contents
You must leave the ``environment.yml``'s name field empty for this
to work out of the box.
``requirements.txt``
^^^^^^^^^^^^^^^^^^^^
This specifies a list of Python packages that would be installed in a virtualenv (or conda environment).
Example Contents
````````````````
::
numpy==1.7
matplotlib==2.1
``REQUIRE``
^^^^^^^^^^^
This specifies a list of Julia packages.
.. note::
Using a ``REQUIRE`` file also requires that the repository contain an
``environment.yml`` file.
Example Contents
````````````````
::
PyPlot
Stats
``apt.txt``
^^^^^^^^^^^
A list of debian packages that should be installed. The base image used is usually the latest released
version of Ubuntu (currently Zesty.)
A list of Debian packages that should be installed. The base image used is usually the latest released
version of Ubuntu.
Example Contents
````````````````
@ -76,23 +102,6 @@ Example Contents
chmod +x postBuild
``REQUIRE``
^^^^^^^^^^^
This specifies a list of Julia packages!
.. note::
Using a ``REQUIRE`` file also requires that the repository contain an
``environment.yml`` file.
Example Contents
````````````````
::
PyPlot
Stats
``runtime.txt``
^^^^^^^^^^^^^^^
@ -105,11 +114,3 @@ Example Contents
::
python-2.7
``Dockerfile``
^^^^^^^^^^^^^^
This will be treated as a regular Dockerfile and a regular Docker build will be performed.
The presence of a Dockerfile prevents all other build behavior.
See the `Binder Documentation <https://mybinder.readthedocs.io/en/latest/dockerfile.html>`_ for
best-practices with Dockerfiles.