Changes between Version 2 and Version 3 of Dev/Doc

Timestamp:

01/25/10 18:48:45 (3 years ago)

Author:

jbenito

Comment:

--

Dev/Doc

@@ -4 +4 @@
 The files format is [http://docutils.sourceforge.net/docs/user/rst/quickref.html reStructuredText].
 
-== Preparation ==
+== Sphinx in Indico ==
 
 Before starting writing documentation, you will need to:
@@ -16 +16 @@
 }}}
 
- * Start the Sphinx project:
+ * Start the Sphinx project (just necessary if you want to create a new Sphinx project):
    - Go to the directory of your documentation and run (use default values):
 {{{
 $ sphinx-quickstart
 }}}
-   - Edit/create your `*.rst` file and save it.
-   - Compile your documentation site: `make html`
-   - Check the result in the folder `_build`.
+ * Edit/create your `*.rst` file and save it.
+ * Compile your documentation site: `make html`
+ * Check the result in the folder `_build`.
+
+Important: keep the current structure for the documentation as it is.
 
 == API ==