Changeset 144 for trunk/docs

Timestamp:

02/27/12 16:16:34 (12 years ago)

Author:

pinsard

Message:

more realistic dev. guide

Location:

trunk/docs/docs_dev/source

Files:

• conf.py (modified) (2 diffs)
• guides/builddoc.rst (modified) (3 diffs)
• guides/contributing.rst (modified) (2 diffs)
• guides/index.rst (deleted)
• guides/index_guides.rst (deleted)
• guides/install.rst (added)
• guides/svnbasiccommands.rst (modified) (1 diff)
• index.rst (modified) (1 diff)
• index_guides.rst (added)
• prolog.rst (added)

trunk/docs/docs_dev/source/conf.py

@@ -35 +35 @@
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+source_encoding = 'iso-8859-15'
 
 # The master toctree document.
@@ -65 +65 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = [ 'prolog.rst']
+
+# Included at the beginning of every source file that is read.
+with open('prolog.rst', 'r') as pr:
+   rst_prolog = pr.read()
 
 # The reST default role (used for this markup: `text`) to use for all documents.

trunk/docs/docs_dev/source/guides/builddoc.rst

@@ -3 +3 @@
 .. TODO
 .. =====
-..
 ..
 .. translation
@@ -16 +15 @@
 .. $Id$
 ..
-.. 
+.. $URL$
+..
 .. - fplod 20101005T164054Z aedon.locean-ipsl.upmc.fr (Darwin)
 ..
@@ -22 +22 @@
 ..
 .. -
-
-.. |project| replace:: SUPERBIB
-.. |project_id| replace:: superbib
 
 .. _builddoc:

trunk/docs/docs_dev/source/guides/contributing.rst

@@ -6 +6 @@
 .. $Id$
 ..
+.. $URL$
 ..
 .. - fplod 20101005T163744Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -20 +21 @@
 ==============
 
-Development is tracked with svn_.
+Development is tracked with :command:`svn`
 
 Installing a *svn* client is not needed unless you want
-to participate in SUPERBIB development.
-
-.. _svn: +todo+
+to participate in |project| development.
 
 You will need a login on forge.ipsl.jussieu.fr to commit your change
 and add/answer tickets.
 
-See :ref:`Contact <contact>` to ask for login or any trouble on your forge.ipsl.jussieu.fr account.
+See |contact| to ask for login or any trouble on your forge.ipsl.jussieu.fr account.
 
 You will find in 
-:ref:`svn Basic Commands <svnbasiccommands>` how to commit your change
+:ref:`svnbasiccommands` how to commit your change
 
 You will find in

trunk/docs/docs_dev/source/guides/svnbasiccommands.rst

@@ -6 +6 @@
 .. $Id$
 .. 
+.. $URL$
+..
 .. - fplod 20101005T162843Z aedon.locean-ipsl.upmc.fr (Darwin)
 ..
 ..   * creation
 .. -
-
-.. |project| replace:: superbib
-.. |dollar| replace:: \$ 
 
 .. _svnbasiccommands:

trunk/docs/docs_dev/source/index.rst

@@ -4 +4 @@
    contain the root `toctree` directive.
 
-Welcome to SUPERBIB's documentation!
-====================================
 
-Contents:
+.. meta::
+   :robots: noindex,nofollow,noarchive
+
+.. _index:
+
+===========================
+SUPERBIB dev. documentation
+===========================
 
 .. toctree::
    :maxdepth: 2
+
+   index_guides
 
 Indices and tables