Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Sign in
Toggle navigation
S
Silex
Project overview
Project overview
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
common
Silex
Commits
6a4fffeb
Commit
6a4fffeb
authored
Mar 08, 2013
by
Dave Marshall
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added a note about writing documentation
parent
fd3ba62d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
14 additions
and
0 deletions
+14
-0
doc/contributing.rst
doc/contributing.rst
+14
-0
No files found.
doc/contributing.rst
View file @
6a4fffeb
...
@@ -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
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment