From d3001686214890e2800536f07873c04e61eff9ac Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Sat, 22 Apr 2017 13:06:29 -0500 Subject: [PATCH] Improve and refactor doc readme - Fix indentation / code blocks. Tabs to spaces. Refactor sections. - Improvements for dual reST+markdown compatibility --- doc/README.md | 65 ++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 32 deletions(-) diff --git a/doc/README.md b/doc/README.md index 8381781fe..138ad8350 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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/``.