@@ -22,30 +22,29 @@ If you are using docker. Run the following commands from the repository root.
22
22
23
23
.. code-block :: bash
24
24
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
29
27
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:
32
29
33
30
.. code-block :: bash
34
31
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
37
34
38
- .. warning ::
35
+ To automatically rebuild the documentation upon change run:
36
+
37
+ .. code-block :: bash
39
38
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 .
43
42
44
43
45
44
Build Documentation
46
45
-------------------
47
46
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.
49
48
50
49
.. code-block :: bash
51
50
@@ -58,6 +57,7 @@ To build the docs:
58
57
$ make html
59
58
$ make spelling
60
59
60
+
61
61
.. _Sphinx installation page : http://sphinx-doc.org/latest/install.html
62
62
.. _install enchant : http://www.abisource.com/projects/enchant/
63
-
63
+ .. _ readthedocs image : https://hub.docker.com/r/webplates/readthedocs/
0 commit comments