Skip to content

Commit 1ad44ba

Browse files
committed
adding message and changing header characters for config files
1 parent ade9acf commit 1ad44ba

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/source/config_files.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
.. NOTE: the header characters are different in this file because it is 'included' in another site
2+
.. see https://raw.githubusercontent.com/jupyterhub/binder/master/doc/using.rst
13
.. _config-files:
24

35
Configuration Files
4-
~~~~~~~~~~~~~~~~~~~
6+
-------------------
57

68
``repo2docker`` looks for configuration files in the repository being built
79
to determine how to build it. In general, ``repo2docker`` uses the same
@@ -31,7 +33,7 @@ Below is a list of supported configuration files (roughly in the order of build
3133
:depth: 1
3234

3335
``Dockerfile``
34-
^^^^^^^^^^^^^^
36+
~~~~~~~~~~~~~~
3537

3638
In the majority of cases, providing your own Dockerfile is not necessary as the base
3739
images provide core functionality, compact image sizes, and efficient builds. We recommend
@@ -46,7 +48,7 @@ best-practices with Dockerfiles.
4648
.. _environment-yml:
4749

4850
``environment.yml``
49-
^^^^^^^^^^^^^^^^^^^
51+
~~~~~~~~~~~~~~~~~~~
5052

5153
``environment.yml`` is the standard configuration file used by Anaconda, conda,
5254
and miniconda that lets you install Python packages.
@@ -63,31 +65,31 @@ a Python version in a ``runtime.txt`` file in addition to your
6365
``environment.yml``, your ``runtime.txt`` **will be ignored**.
6466

6567
``requirements.txt``
66-
^^^^^^^^^^^^^^^^^^^^
68+
~~~~~~~~~~~~~~~~~~~~
6769

6870
This specifies a list of Python packages that should be installed in your
6971
environment. Our
7072
`requirements.txt example <https://github.com/binder-examples/requirements/blob/master/requirements.txt>`_
7173
on GitHub shows a typical requirements file.
7274

7375
``REQUIRE``
74-
^^^^^^^^^^^
76+
~~~~~~~~~~~
7577

7678
This specifies a list of Julia packages. Repositories with a ``REQUIRE`` file
7779
**must also contain an** ``environment.yml`` **file**. To see an example of a
7880
Julia repository with ``REQUIRE`` and ``environment.yml``,
7981
visit `binder-examples/julia-python <https://github.com/binder-examples/julia-python>`_.
8082

8183
``install.R``
82-
^^^^^^^^^^^^^
84+
~~~~~~~~~~~~~
8385

8486
This is used to install R libraries pinned to a specific snapshot on
8587
`MRAN <https://mran.microsoft.com/documents/rro/reproducibility>`_.
8688
To set the date of the snapshot add a runtime.txt_.
8789
For an example ``install.R`` file, visit our `example install.R file <https://github.com/binder-examples/r/blob/master/install.R>`_.
8890

8991
``apt.txt``
90-
^^^^^^^^^^^
92+
~~~~~~~~~~~
9193

9294
A list of Debian packages that should be installed. The base image used is usually the latest released
9395
version of Ubuntu.
@@ -97,7 +99,7 @@ We use ``apt.txt``, for example, to install LaTeX in our
9799

98100

99101
``setup.py``
100-
^^^^^^^^^^^^
102+
~~~~~~~~~~~~
101103

102104
To install your repository like a Python package, you may include a
103105
``setup.py`` file. repo2docker installs ``setup.py`` files by running
@@ -110,7 +112,7 @@ repo2docker **requires configuration files such as** ``environment.yml`` or
110112
.. _postBuild:
111113

112114
``postBuild``
113-
^^^^^^^^^^^^^
115+
~~~~~~~~~~~~~
114116

115117
A script that can contain arbitrary commands to be run after the whole repository has been built. If you
116118
want this to be a shell script, make sure the first line is ```#!/bin/bash``.
@@ -122,7 +124,7 @@ their demo for binder <https://github.com/jupyterlab/jupyterlab-demo/blob/master
122124
.. _runtime.txt:
123125

124126
``runtime.txt``
125-
^^^^^^^^^^^^^^^
127+
~~~~~~~~~~~~~~~
126128

127129
This allows you to control the runtime of Python or R.
128130

0 commit comments

Comments
 (0)