mirror of https://github.com/kivy/kivy.git
Update README.md
This commit is contained in:
parent
f859c66076
commit
3b9add262c
|
@ -1,32 +1,38 @@
|
|||
Kivy - Documentation
|
||||
====================
|
||||
|
||||
You can access the latest documentation on the web :
|
||||
You can access the latest documentation on the web:
|
||||
* http://kivy.org/docs
|
||||
|
||||
|
||||
How to build the documentation
|
||||
------------------------------
|
||||
|
||||
You need to install :
|
||||
You need to install:
|
||||
|
||||
* Python Sphinx
|
||||
- Where apt-get is available :
|
||||
apt-get install python-sphinx
|
||||
- On Windows (or from inside your virtualenv) :
|
||||
- Where apt-get is available:
|
||||
```
|
||||
apt-get install python-sphinx
|
||||
```
|
||||
|
||||
- On Windows (or from inside your virtualenv):
|
||||
|
||||
Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
|
||||
To install pip, run python setup.py install in the pip directory.
|
||||
Now run :
|
||||
|
||||
To install pip, run python setup.py install in the pip directory. Now run:
|
||||
```
|
||||
pip install sphinxcontrib-blockdiag sphinxcontrib-seqdiag
|
||||
pip install sphinxcontrib-actdiag sphinxcontrib-nwdiag
|
||||
|
||||
Or just use the provided doc-requirements.txt :
|
||||
```
|
||||
Or just use the provided `doc-requirements.txt`:
|
||||
```
|
||||
pip install -r doc-requirements.txt
|
||||
```
|
||||
|
||||
* Latest kivy
|
||||
|
||||
Generate documentation using make::
|
||||
make html
|
||||
Generate documentation using make: `make html`.
|
||||
|
||||
Documentation will be accessible in build/html/
|
||||
Documentation will be accessible in `build/html/`.
|
||||
|
||||
|
|
Loading…
Reference in New Issue