Improve and refactor doc readme

- Fix indentation / code blocks. Tabs to spaces. Refactor sections.
- Improvements for dual reST+markdown compatibility
This commit is contained in:
Tony Narlock 2017-04-22 13:06:29 -05:00
parent e831904e38
commit d300168621
1 changed files with 33 additions and 32 deletions

View File

@ -2,47 +2,48 @@ Kivy - Documentation
====================
You can access the latest documentation on the web:
* http://kivy.org/docs
* http://kivy.org/docs
How to build the documentation
------------------------------
Contributing
------------
You need to install:
If you intend on editing and contributing documentation, assure the kivy source
code is up to date before proceeding. If your documentation is outdated, it
could result in merge conflicts.
* Python Sphinx
- With pip:
```
pip install sphinx
```
Install Sphinx
--------------
- With apt-get:
```
apt-get install python-sphinx
```
- With pip:
``pip install sphinx``
- With MacPorts:
```
port install py34-sphinx
```
- With apt-get:
``apt-get install python-sphinx``
- On Windows (or from inside your virtualenv):
- With MacPorts:
``port install py34-sphinx``
Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
- On Windows (or from inside your virtualenv):
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`:
```
pip install -r doc-requirements.txt
```
Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
* Latest kivy
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*:
``pip install -r doc-requirements.txt``
Building the documentation
--------------------------
Generate documentation using make: `make html`.
Documentation will be accessible in `build/html/`.
Generate documentation using make: ``make html``.
Documentation will be accessible in ``build/html/``.