From ac2fdca029c519ac1c0dfb6cb8d9f44d6edbf358 Mon Sep 17 00:00:00 2001 From: EdTheDev Date: Tue, 2 Oct 2012 12:33:14 -0500 Subject: [PATCH 1/2] Extended a title line of '~' to allow 'make html' to finish. Seems to have been a warning in previous versions, and is not a halting error. (As of library default from Ubuntu 12.04). --- doc/sources/installation/installation-linux.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sources/installation/installation-linux.rst b/doc/sources/installation/installation-linux.rst index f68d41482..febb464e4 100644 --- a/doc/sources/installation/installation-linux.rst +++ b/doc/sources/installation/installation-linux.rst @@ -7,7 +7,7 @@ Prerequisites ------------- Ubuntu (11.10 or newer) -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~ :: From df5a1ecc025616f1dea63ea084f4df2ea683e07c Mon Sep 17 00:00:00 2001 From: EdTheDev Date: Tue, 2 Oct 2012 12:34:49 -0500 Subject: [PATCH 2/2] Expanded the 'Documentation Contributions' section to make it clear where the documentation is stored, and how changes are expected to be handled. Also added a link to ReStructuredText documentation, mentioned the dependency on python-sphinx, and added the command to rebuild the HTML. --- doc/sources/contribute.rst | 40 ++++++++++++++++++++++++++++++++++---- 1 file changed, 36 insertions(+), 4 deletions(-) diff --git a/doc/sources/contribute.rst b/doc/sources/contribute.rst index b2dcea3b4..49bf33971 100644 --- a/doc/sources/contribute.rst +++ b/doc/sources/contribute.rst @@ -175,11 +175,43 @@ get instant karma. Congratulations, you're a hero! Documentation Contributions --------------------------- -Documentation contributions generally follow the same workflow as code -contributions, just a bit more lax. We don't ask you to go through all the -hassle just to correct a single typo. For more complex contributions, please -consider following the suggested workflow though. +Documentation contributions generally follow the same workflow as code contributions, just a bit more lax. + #. Following the instructions above, + + #. Fork the repository. + + #. Clone your fork to your computer. + + #. Setup kivy repo as a remote source. + + #. Install python-sphinx. (See docs/sources/README for assistance.) + + #. Use ReStructuredText_Markup_ to make changes to the HTML documentation in docs/sources. + +.. _ReStructuredText_Markup: http://docutils.sourceforge.net/rst.html + +To submit a documentation update, use the following steps: + + #. Create a new, appropriately named branch in your local repository.:: + + git checkout -b my_docs_update + + #. Modify the documentation with your correction or improvement. + #. Re-generate the HTML pages, and review your update.:: + + make html + + #. Give each commit an appropriate commit message, so that others who are not familiar with the matter get a good idea of what you changed. + #. Keep each commit focused on a single related theme. Don't commit other stuff that doesn't logically belong to this update. + + #. Push to your remote repository on GitHub:: + + git push + + #. Send a *Pull Request* with a description of what you changed via the button in the GitHub interface of your repository. + +We don't ask you to go through all the hassle just to correct a single typo, but for more complex contributions, please follow the suggested workflow. Docstrings ~~~~~~~~~~