Skip to content

Commit 3b9add2

Browse files
committed
Update README.md
1 parent f859c66 commit 3b9add2

File tree

1 file changed

+18
-12
lines changed

1 file changed

+18
-12
lines changed

doc/README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,38 @@
11
Kivy - Documentation
22
====================
33

4-
You can access the latest documentation on the web :
4+
You can access the latest documentation on the web:
55
* http://kivy.org/docs
66

77

88
How to build the documentation
99
------------------------------
1010

11-
You need to install :
11+
You need to install:
1212

1313
* Python Sphinx
14-
- Where apt-get is available :
15-
apt-get install python-sphinx
16-
- On Windows (or from inside your virtualenv) :
14+
- Where apt-get is available:
15+
```
16+
apt-get install python-sphinx
17+
```
18+
19+
- On Windows (or from inside your virtualenv):
20+
1721
Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
18-
To install pip, run python setup.py install in the pip directory.
19-
Now run :
22+
23+
To install pip, run python setup.py install in the pip directory. Now run:
24+
```
2025
pip install sphinxcontrib-blockdiag sphinxcontrib-seqdiag
2126
pip install sphinxcontrib-actdiag sphinxcontrib-nwdiag
22-
23-
Or just use the provided doc-requirements.txt :
27+
```
28+
Or just use the provided `doc-requirements.txt`:
29+
```
2430
pip install -r doc-requirements.txt
31+
```
2532

2633
* Latest kivy
2734

28-
Generate documentation using make::
29-
make html
35+
Generate documentation using make: `make html`.
3036

31-
Documentation will be accessible in build/html/
37+
Documentation will be accessible in `build/html/`.
3238

0 commit comments

Comments
 (0)