Skip to content

Commit 877202a

Browse files
committed
Use "Smart Title Case" for all titles
1 parent 90ad89f commit 877202a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99

1010
A Docker image for [Sphinx](http://www.sphinx-doc.org/), a documentation tool written in Python.
1111

12-
## Supported tags and respective `Dockerfile` links
12+
## Supported Tags and Respective `Dockerfile` Links
1313

1414
* `1.7.1`, `latest` ([Dockerfile](https://github.com/keimlink/docker-sphinx-doc/blob/master/Dockerfile)) [![Image download size and number of layers](https://images.microbadger.com/badges/image/keimlink/sphinx-doc.svg)](https://microbadger.com/images/keimlink/sphinx-doc "Image download size and number of layers")
1515
* `1.7.1-latex`, `latex` ([Dockerfile.latex](https://github.com/keimlink/docker-sphinx-doc/blob/master/Dockerfile.latex)) [![Image download size and number of layers](https://images.microbadger.com/badges/image/keimlink/sphinx-doc:latex.svg)](https://microbadger.com/images/keimlink/sphinx-doc:latex "Image download size and number of layers")
1616

17-
## What is Sphinx?
17+
## What Is Sphinx?
1818

1919
[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.
2020

21-
## How to use this image
21+
## How to Use This Image
2222

23-
### Use the image for your Sphinx project
23+
### Use the Image for Your Sphinx Project
2424

2525
First run `sphinx-quickstart` to set up a source directory and a configuration:
2626

@@ -34,7 +34,7 @@ Then build the HTML documentation:
3434
docker run -it --rm -v "$(pwd)/docs":/home/python/docs keimlink/sphinx-doc:1.7.1 make -C docs html
3535
```
3636

37-
### Create a `Dockerfile` for your Sphinx project
37+
### Create a `Dockerfile` for Your Sphinx Project
3838

3939
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.
4040

@@ -68,7 +68,7 @@ docker run -it -p 8000:8000 --rm -v "$(pwd)/docs":/home/python/docs sphinx-autob
6868

6969
The documentation should served at <http://127.0.0.1:8000>. It will be rebuild when a file is changed.
7070

71-
## Image variants
71+
## Image Variants
7272

7373
The `sphinx-doc` images come in many flavours, each designed for a specific use case.
7474

0 commit comments

Comments
 (0)