Changeset 665 for branches/PublicaMundi_David-devel/docs/contribute/doc.rst

Timestamp:

Jun 16, 2015, 2:06:21 PM (9 years ago)

Author:

nbozon

Message:

added missing documentation files

File:

• branches/PublicaMundi_David-devel/docs/contribute/doc.rst (modified) (5 diffs)

branches/PublicaMundi_David-devel/docs/contribute/doc.rst

@@ -1 +1 @@
 .. _contribute_doc:
+
+.. include:: <xhtml1-lat1.txt>
+.. include:: <xhtml1-symbol.txt>
 
 Contribute documentation
 ==================
 
-ZOO Documentation is a collaborative process managed by the ZOO develoeprs. Anybody is welcome to contribute to the ZOO-Project documentation. Please consider the following instructions before doing so.
+ZOO Documentation is a collaborative process managed by the ZOO developers. Anybody is welcome to contribute to the ZOO-Project documentation. Please consider the following instructions before doing so.
+
+General information
+------------------------
 
 For new comers
-*************************
+..........................
 
 New users are encouraged to contribute documentation using the following ways:
 
-* Download the ZOO-Project svn, edit the documentation files located /docs directory and share the modifications through a new ticket set to 'Documentation' tracker
+* Download the ZOO-Project svn, edit the documentation files
+  located /docs directory and share the modifications through a new
+  ticket set to 'Documentation' tracker
+  
 * Create a wiki page containg new or corrected documentation text, and create a new ticket to report its creation. 
 
@@ -17 +26 @@
 
 For registered developers
-****************************
+........................................
 
 The current structure of the ZOO Project documentation process is for developers with :ref:`SVN <svn>` commit access to maintain their documents in reStructuredText format, and therefore all documents live in the /docs directory in SVN.  The `Sphinx <http://sphinx.pocoo.org/>`__ documentation generator is used to convert the reStructuredText files to html, and the live
@@ -27 +36 @@
 
 On Linux
-***********
+.................
 
-* Make sure you have the Python dev and setuptools packages installed.
-   On Ubuntu:
+* Make sure you have the Python dev and setuptools packages installed. For example on Ubuntu:
 
    ::
@@ -73 +81 @@
 
 
-On Mac OS X
-****************
+On Mac OS X |trade|
+..................................
 
 * Install sphinx using easy_install:
@@ -109 +117 @@
 
 
-On Windows
-**************
+On Windows |trade|
+................................
 
 * Install `Python 2.X <http://www.python.org/>`__