You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,18 @@
9
9
10
10
A Docker image for [Sphinx](http://www.sphinx-doc.org/), a documentation tool written in Python.
11
11
12
-
## Supported tags and respective`Dockerfile`links
12
+
## Supported Tags and Respective`Dockerfile`Links
13
13
14
14
*`1.7.1`, `latest` ([Dockerfile](https://github.com/keimlink/docker-sphinx-doc/blob/master/Dockerfile)) [](https://microbadger.com/images/keimlink/sphinx-doc"Image download size and number of layers")
15
15
*`1.7.1-latex`, `latex` ([Dockerfile.latex](https://github.com/keimlink/docker-sphinx-doc/blob/master/Dockerfile.latex)) [](https://microbadger.com/images/keimlink/sphinx-doc:latex"Image download size and number of layers")
16
16
17
-
## What is Sphinx?
17
+
## What Is Sphinx?
18
18
19
19
[Sphinx](http://www.sphinx-doc.org/) is a tool that makes it easy to create intelligent and beautiful documentation. It has excellent facilities for the documentation of software projects in a range of languages. Output formats like HTML, LaTeX, ePub, Texinfo, manual pages and plain text are supported. More than 50 extensions contributed by users are available.
20
20
21
-
## How to use this image
21
+
## How to Use This Image
22
22
23
-
### Use the image for your Sphinx project
23
+
### Use the Image for Your Sphinx Project
24
24
25
25
First run `sphinx-quickstart` to set up a source directory and a configuration:
26
26
@@ -34,7 +34,7 @@ Then build the HTML documentation:
34
34
docker run -it --rm -v "$(pwd)/docs":/home/python/docs keimlink/sphinx-doc:1.7.1 make -C docs html
35
35
```
36
36
37
-
### Create a `Dockerfile` for your Sphinx project
37
+
### Create a `Dockerfile` for Your Sphinx Project
38
38
39
39
If you want to extend the image you can create a `Dockerfile` for your Sphinx project. In this example [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild) will be used to rebuild the documentation when a change is detected.
0 commit comments