Skip to content

Commit c21183a

Browse files
authored
Merge pull request #10 from DM-Lab-UvA/doc
Update documentation
2 parents 79da31c + 94815a0 commit c21183a

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

.github/workflows/publish_docker.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ jobs:
6464
with:
6565
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
6666
subject-digest: ${{ steps.push.outputs.digest }}
67-
push-to-registry: true
67+
push-to-registry: false

docs/user_guide/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Installation
22
============
33

4-
This guide shows you how to build and install `mcmpy`.
4+
This guide shows you how to build and install ``mcmpy``.
55
There are two supported installation methods for this project:
66

77
1. Installation using Docker
@@ -12,7 +12,7 @@ Installation using Docker
1212
-------------------------
1313

1414
First `install Docker <https://docs.docker.com/get-started/get-docker/>`_.
15-
Create or navigate to the folder that contains all input files necessary for the data analysis and save the following block of code as a file named `docker-compose.yml`:
15+
Create or navigate to the folder that contains all input files necessary for the data analysis and save the following block of code as a file named ``docker-compose.yml``:
1616

1717
.. code-block:: yaml
1818
@@ -33,7 +33,7 @@ To launch the container environment, open a terminal in your directory and execu
3333
3434
When running the command for the first time, it will download the pre-built Docker image and automatically start a jupyter server.
3535
This returns a link beginning with ``127.0.0.1``, which can be opened in a local browser.
36-
Next times, it will not download the latest Docker image but just launch a container with this downloaded version.
36+
Next times, it will not download the latest Docker image but just launch a container with the latest downloaded version.
3737
If a newer version of the image exists, run the following command first:
3838

3939
.. code-block:: bash

0 commit comments

Comments
 (0)