Skip to content

Commit 1cf489c

Browse files
authored
Update README.rst
Fixed syntax (for some reason I had assumed this was a markdown file, not RST)
1 parent 5715bfc commit 1cf489c

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,41 +81,41 @@ See also `thebe.rst <thebe.rst>`_ for additional reader-oriented notes.
8181
Extending the sagemath Docker image
8282
-----------------------------------
8383

84-
The sample [`Dockerfile`](https://github.com/sagemath/sage-binder-env/blob/master/Dockerfile)
85-
in this repository is based on the official `sagemath/sagemath` Docker image. It includes
84+
The sample `Dockerfile <https://github.com/sagemath/sage-binder-env/blob/master/Dockerfile>`_
85+
in this repository is based on the official ``sagemath/sagemath`` Docker image. It includes
8686
Sage itself, and all the software packages typically included in a standard Sage installation,
8787
though not *everything* (in particular not optional Sage SPKGs, or other system software
8888
packages).
8989

90-
So in order to install additional Sage SPKGs it is possible to include a line like
90+
So in order to install additional Sage SPKGs it is possible to include a line like::
9191

9292
RUN sage -i <spkg-name>
9393
94-
in the `Dockerfile`. Note, due to a current shortcoming in the official Docker image it is
95-
also necessary to install the `make` system package before running `sage -i`. See the
94+
in the ``Dockerfile``. Note, due to a current shortcoming in the official Docker image it is
95+
also necessary to install the `make` system package before running ``sage -i``. See the
9696
next section.
9797

9898
Installing additional system packages
9999
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
100100

101101
To add additional software packages a couple more steps are involved,
102-
albeit relatively simple. The thing to understand about the `sagemath/sagemath` image is
102+
albeit relatively simple. The thing to understand about the ``sagemath/sagemath`` image is
103103
that by default it puts you in a user called `sage`, so in order to install system packages
104104
it is necessary, when extending the image, to first switch back to the `root` user.
105105
Then, because the image is based on Ubuntu, the `apt-get` command can be used to install
106106
Ubuntu packages. The canonical way to do this in a `Dockerfile` involves updating the
107107
APT cache, installing the packages, and then cleaning up the APT cache again all within
108-
a single command (this is in order to keep cache files out of the image):
108+
a single command (this is in order to keep cache files out of the image)::
109109

110110
USER root
111111
RUN apt-get -qq update \
112112
&& apt-get -qq install -y --no-install-recommends <packages-to-install> \
113113
&& apt-get -qq clean
114114
USER sage
115115
116-
Finally, just make sure toward the end of the `Dockerfile` that you switch the image
117-
user back to `sage` (so that when users run the container they are not running it as
118-
`root`.
116+
Finally, just make sure toward the end of the ``Dockerfile`` that you switch the image
117+
user back to ``sage`` (so that when users run the container they are not running it as
118+
``root``.
119119

120120

121121
Authors

0 commit comments

Comments
 (0)