Skip to content

Commit abe1d33

Browse files
committedOct 20, 2016
Update docker usage
1 parent 9059cb7 commit abe1d33

File tree

3 files changed

+15
-35
lines changed

3 files changed

+15
-35
lines changed
 

‎Dockerfile

-21
This file was deleted.

‎development/documentation.rst

+14-14
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,29 @@ If you are using docker. Run the following commands from the repository root.
2222

2323
.. code-block:: bash
2424
25-
$ docker run --rm -it -v "$PWD":/doc phphttp/documentation
26-
$ # You are now in the docker image
27-
$ make html
28-
$ make spelling
25+
$ docker run --rm -t -v "$PWD":/doc webplates/readthedocs build
26+
$ docker run --rm -t -v "$PWD":/doc webplates/readthedocs check
2927
30-
Alternatively you can run the commands directly from the host
31-
without entering the container shell:
28+
Alternatively you can run the make commands as well:
3229

3330
.. code-block:: bash
3431
35-
$ docker run --rm -t -v "$PWD":/doc phphttp/documentation make html
36-
$ docker run --rm -t -v "$PWD":/doc phphttp/documentation make spelling
32+
$ docker run --rm -t -v "$PWD":/doc webplates/readthedocs make html
33+
$ docker run --rm -t -v "$PWD":/doc webplates/readthedocs make spelling
3734
38-
.. warning::
35+
To automatically rebuild the documentation upon change run:
36+
37+
.. code-block:: bash
3938
40-
The Docker container runs with `root` user by default
41-
which means the owner of the generated files will be `root`
42-
on the host too.
39+
$ docker run --rm -t -v "$PWD":/doc webplates/readthedocs watch
40+
41+
For more details see the `readthedocs image`_ documentation.
4342

4443

4544
Build Documentation
4645
-------------------
4746

48-
Before we can build the documentation we have to make sure to install all requirements.
47+
Before building the documentation make sure to install all requirements.
4948

5049
.. code-block:: bash
5150
@@ -58,6 +57,7 @@ To build the docs:
5857
$ make html
5958
$ make spelling
6059
60+
6161
.. _Sphinx installation page: http://sphinx-doc.org/latest/install.html
6262
.. _install enchant: http://www.abisource.com/projects/enchant/
63-
63+
.. _readthedocs image: https://hub.docker.com/r/webplates/readthedocs/

‎watch.sh

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#!/usr/bin/env bash
22

3+
# Note: --include is not available in all versions of inotifywait
34
while inotifywait -e modify -r --include ".+?\.rst" .; do
45
make html
56
done

0 commit comments

Comments
 (0)
Please sign in to comment.