← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to docs/contributing/documentation.rst

  • Committer: Monty Taylor
  • Date: 2011-03-10 18:18:24 UTC
  • mfrom: (2222.2.1 drizzle)
  • mto: This revision was merged to the branch mainline in revision 2228.
  • Revision ID: mordred@inaugust.com-20110310181824-mv5zqrahenb62y5i
Merge Mark: Documentation Edits

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/contributing/documentation.rst
3
3
Contributing Documentation
4
4
==========================
5
5
 
6
 
Our documentation is written using `Sphinx Documentation Generator <http://sphinx.pocoo.org/>`_ which uses the `reStructuredText <http://docutils.sf.net/rst.html>`_ format.
 
6
Our documentation is written using
 
7
`Sphinx Documentation Generator <http://sphinx.pocoo.org/>`_
 
8
which uses the `reStructuredText <http://docutils.sf.net/rst.html>`_ format.
7
9
 
8
 
All our documentation is stored in the main source reporistory in the docs/
9
 
directory, and every merge into trunk triggers a rebuild of our `documentation site <http://docs.drizzle.org/>`_.
 
10
All our documentation is stored in the main source reposatory in the docs/
 
11
directory, and every merge into trunk triggers a rebuild of our
 
12
`documentation site <http://docs.drizzle.org/>`_.
10
13
 
11
14
Requirements
12
15
------------
15
18
all of it will build correctly in that version.  For correct documentation
16
19
version 1.0 is required.
17
20
 
18
 
When building the documentation warnings become errors, so the documentation
 
21
When building the documentation warnings are treated as errors, so the documentation
19
22
needs to be warning free in 1.0.
20
23
 
21
24
Documentation Files
41
44
--------------------
42
45
 
43
46
The documentation is in the reStructured text format which is a wiki-like markup
44
 
laungauge ideal for documentation.
 
47
language ideal for documentation.
45
48
 
46
49
Headings
47
50
^^^^^^^^