From 1e88e313b6259ffea4bd88163443305fc432965e Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Thu, 1 Feb 2018 00:48:43 -0800 Subject: [PATCH] Clarify that --debug and --no-build are for debugging only They output a Dockerfile that can not be used outside of repo2docker, so are only useful as debugging aids. Fixes #202 --- docs/source/usage.rst | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 60dc0701..517e6ee4 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -95,17 +95,26 @@ After building (it might take a while!), it should output a message in your term If you copy/paste that URL into your browser you will see a Jupyter Notebook with the contents of the repository you have just built! -Displaying the image Dockerfile -------------------------------- +Debugging the build process +--------------------------- -``repo2docker`` will generate a Dockerfile that composes the created Docker image. -To see the contents of this Dockerfile without building the image use -the ``--debug`` and ``--no-build`` flags like so:: +If you want to debug and understand the details of the docker image being built, +you can pass the ``debug`` parameter to the commandline. This will print the +generated ``Dockerfile`` before building and running it. - jupyter-repo2docker --debug --no-build https://github.com/jakevdp/PythonDataScienceHandbook + .. code-block:: bash + + jupyter-repo2docker --debug https://github.com/jakevdp/PythonDataScienceHandbook + + +If you only want to see the ``Dockerfile`` output but not actually build it, +you can also pass ``--no-build`` to the commandline. This ``Dockerfile`` output +is for **debugging purposes** only - it can not be used by docker directly. + + .. code-block:: bash + + jupyter-repo2docker --no-build --debug https://github.com/jakevdp/PythonDataScienceHandbook -This will output the contents of the Dockerfile in your console. Note that it -will **not** build the image. Accessing help from the command line ------------------------------------