File tree 1 file changed +18
-12
lines changed 1 file changed +18
-12
lines changed Original file line number Diff line number Diff line change 1
1
Kivy - Documentation
2
2
====================
3
3
4
- You can access the latest documentation on the web :
4
+ You can access the latest documentation on the web:
5
5
* http://kivy.org/docs
6
6
7
7
8
8
How to build the documentation
9
9
------------------------------
10
10
11
- You need to install :
11
+ You need to install:
12
12
13
13
* 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
+
17
21
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
+ ```
20
25
pip install sphinxcontrib-blockdiag sphinxcontrib-seqdiag
21
26
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
+ ```
24
30
pip install -r doc-requirements.txt
31
+ ```
25
32
26
33
* Latest kivy
27
34
28
- Generate documentation using make::
29
- make html
35
+ Generate documentation using make: ` make html ` .
30
36
31
- Documentation will be accessible in build/html/
37
+ Documentation will be accessible in ` build/html/ ` .
32
38
You can’t perform that action at this time.
0 commit comments