@@ -28,10 +28,9 @@ Below is a list of supported configuration files (roughly in the order of build
2828``environment.yml `` - Install a Python environment
2929==================================================
3030
31- ``environment.yml `` is the standard configuration file used by Anaconda, conda,
32- and miniconda that lets you install packages in the data analytics stack (it
33- primarily installs Python packages, though can be used to install a range of
34- non-Python packages as well).
31+ ``environment.yml `` is the standard configuration file used by `conda <https://conda.io >`_
32+ that lets you install any kind of package,
33+ including Python, R, and C/C++ packages.
3534
3635.. note ::
3736
@@ -41,17 +40,19 @@ non-Python packages as well).
4140 file.
4241
4342You can also specify which Python version to install in your built environment
44- with ``environment.yml ``. By default, ``repo2docker `` ** installs
45- Python 3.6 ** with your ``environment.yml `` unless you include the version of
46- Python in the file. ``conda `` supports Python versions 3.6, 3.5, 3.4, and 2.7.
47- ``repo2docker `` support is best with Python 3.6, 3.5, and 2.7.
43+ with ``environment.yml ``. By default, ``repo2docker `` installs
44+ | default_python | with your ``environment.yml `` unless you include the version of
45+ Python in this file. ``conda `` supports all versions of Python,
46+ though ``repo2docker `` support is best with Python 3.7, 3. 6, 3.5 and 2.7.
4847
4948.. warning ::
5049 If you include a Python version in a ``runtime.txt `` file in addition to your
5150 ``environment.yml ``, your ``runtime.txt `` will be ignored.
5251
5352.. _requirements.txt :
5453
54+ .. _requirements.txt :
55+
5556``requirements.txt `` - Install a Python environment
5657===================================================
5758
@@ -61,6 +62,8 @@ environment. Our
6162on GitHub shows a typical requirements file.
6263
6364
65+ .. _setup.py :
66+
6467``setup.py `` - Install Python packages
6568======================================
6669
@@ -70,6 +73,8 @@ To install your repository like a Python package, you may include a
7073
7174.. _REQUIRE :
7275
76+ .. _REQUIRE :
77+
7378``REQUIRE `` - Install a Julia environment
7479=========================================
7580
@@ -78,6 +83,8 @@ Julia repository with ``REQUIRE`` and ``environment.yml``,
7883visit `binder-examples/julia-python <https://github.com/binder-examples/julia-python >`_.
7984
8085
86+ .. _install.R :
87+
8188``install.R `` - Install an R/RStudio environment
8289================================================
8390
@@ -87,6 +94,8 @@ To set the date of the snapshot add a runtime.txt_.
8794For an example ``install.R `` file, visit our `example install.R file <https://github.com/binder-examples/r/blob/master/install.R >`_.
8895
8996
97+ .. _apt.txt :
98+
9099``apt.txt `` - Install packages with apt-get
91100===========================================
92101
@@ -97,6 +106,8 @@ We use ``apt.txt``, for example, to install LaTeX in our
97106`example apt.txt for LaTeX <https://github.com/binder-examples/latex/blob/master/apt.txt >`_.
98107
99108
109+ .. _DESCRIPTION :
110+
100111``DESCRIPTION `` - Install an R package
101112======================================
102113
@@ -108,6 +119,9 @@ You also need to have a ``runtime.txt`` file that is formatted as
108119``r-<YYYY>-<MM>-<DD> ``, where YYYY-MM-DD is a snapshot of MRAN that will be
109120used for your R installation.
110121
122+
123+ .. _manifest.xml :
124+
111125``manifest.xml `` - Install Stencila
112126===================================
113127
@@ -156,21 +170,29 @@ If you only need to run things once during the build phase use :ref:`postBuild`.
156170
157171
158172.. TODO: Discuss runtime limits, best practices, etc.
159- Also, point to an example.
160173
161174 .. _runtime.txt :
162175
163176``runtime.txt `` - Specifying runtimes
164177=====================================
165178
166- This allows you to control the runtime of Python or R.
179+ Sometimes you want to specify the version of the runtime
180+ (e.g. the version of Python or R),
181+ but the environment specification format don't let you specify this information
182+ (e.g. requirements.txt or install.R).
183+ For these cases, we have a special file, ``runtime.txt ``.
184+
185+ .. note ::
186+
187+ ``runtime.txt `` is only supported when used with environment specifications
188+ that do not already support specifying the runtime
189+ (e.g. when using ``environment.yml `` for conda or ``REQUIRE `` for Julia,
190+ ``runtime.txt `` will be ignored).
167191
168192To use python-2.7: add ``python-2.7 `` in runtime.txt file.
169- The repository will run in a virtualenv with
193+ The repository will run in an env with
170194Python 2 installed. To see a full example repository, visit our
171195`Python2 example <https://github.com/binder-examples/python2_runtime/blob/master/runtime.txt >`_.
172- **Python versions in ** ``runtime.txt `` **are ignored when ** ``environment.yml `` **is
173- present in the same folder **.
174196
175197repo2docker uses R libraries pinned to a specific snapshot on
176198`MRAN <https://mran.microsoft.com/documents/rro/reproducibility >`_.
0 commit comments