Commit 6a4fffeb authored by Dave Marshall's avatar Dave Marshall

Added a note about writing documentation

parent fd3ba62d
...@@ -12,6 +12,8 @@ steps. ...@@ -12,6 +12,8 @@ steps.
* Add tests for it. This is important so we don't break it in a future version unintentionally. * Add tests for it. This is important so we don't break it in a future version unintentionally.
* Optionally, add some technical documentation.
* Send a pull request. Bonus points for topic branches. * Send a pull request. Bonus points for topic branches.
If you have a big change or would like to discuss something, If you have a big change or would like to discuss something,
...@@ -22,3 +24,15 @@ please join us on the `mailing list ...@@ -22,3 +24,15 @@ please join us on the `mailing list
Any code you contribute must be licensed under the MIT Any code you contribute must be licensed under the MIT
License. License.
Writing Documentation
=====================
The documentation is written in `reStructuredText
<http://docutils.sourceforge.net/rst.html>`_ and can be generated using `sphinx
<http://sphinx-doc.org>`_.
.. code-block:: bash
$ cd doc
$ sphinx-build -b html . build
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment