Add modules to list and to index to have docstring integrated into the documentation.
authorSandrine Ribeau <sandrine.ribeau@logilab.fr>
Wed, 05 Nov 2008 11:22:05 -0800
changeset 1 88d637274072
parent 0 b97547f5f1fa
child 2 3847ffe2f86c
Add modules to list and to index to have docstring integrated into the documentation. Needs to be completed. Sphinx required to explicitely list which modules we want to include in the documentation.
doc/conf.py
doc/howto.fr.txt
doc/modules.txt
--- a/doc/conf.py	Wed Nov 05 15:52:50 2008 +0100
+++ b/doc/conf.py	Wed Nov 05 11:22:05 2008 -0800
@@ -23,8 +23,8 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
-
+extensions = ['sphinx.ext.autodoc']
+autoclass_content = 'both'
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.templates']
 
@@ -122,7 +122,7 @@
 #html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_use_modindex = True
+html_use_modindex = True
 
 # If false, no index is generated.
 #html_use_index = True
@@ -139,7 +139,7 @@
 #html_use_opensearch = ''
 
 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+html_file_suffix = '.html'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'Cubicwebdoc'
--- a/doc/howto.fr.txt	Wed Nov 05 15:52:50 2008 +0100
+++ b/doc/howto.fr.txt	Wed Nov 05 11:22:05 2008 -0800
@@ -10,7 +10,8 @@
   * Modification d'une relation non finale
 
   * Modification d'une relation finale 
-  [TO COMPLETE]
+
+[TO COMPLETE]
 
 * Comment créer un utilisateur anonyme?
   
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/modules.txt	Wed Nov 05 11:22:05 2008 -0800
@@ -0,0 +1,106 @@
+.. -*- coding: utf-8 -*-
+
+
+:mod:`cubes.addressbook` 
+========================
+
+.. automodule:: cubes.addressbook
+   :members:
+
+:mod:`cubicweb` 
+===============
+
+.. automodule:: cubicweb
+   :members:
+
+:mod:`cubicweb.common`
+======================
+
+.. automodule:: cubicweb.common
+   :members:
+
+:mod:`cubicweb.devtools`
+========================
+
+.. automodule:: cubicweb.devtools
+   :members:
+
+:mod:`cubicweb.entities`
+========================
+
+.. automodule:: cubicweb.entities
+   :members:
+
+:mod:`cubicweb.etwist`
+======================
+
+.. automodule:: cubicweb.etwist
+   :members:
+
+:mod:`cubicweb.goa`
+===================
+
+.. automodule:: cubicweb.goa
+   :members:
+
+:mod:`cubicweb.schemas`
+=======================
+
+.. automodule:: cubicweb.schemas
+   :members:
+
+:mod:`cubicweb.server`
+======================
+
+.. automodule:: cubicweb.server
+   :members:
+
+:mod:`cubicweb.skeleton`
+========================
+
+.. automodule:: cubicweb.skeleton
+   :members:
+
+:mod:`cubicweb.sobjects`
+========================
+
+.. automodule:: cubicweb.sobjects
+   :members:
+
+:mod:`cubicweb.web`
+===================
+
+.. automodule:: cubicweb.web
+   :members:
+
+:mod:`cubicweb.wsgi`
+====================
+
+.. automodule:: cubicweb.wsgi
+   :members:
+
+:mod:`indexer`
+==============
+
+.. automodule:: indexer
+   :members:
+
+:mod:`logilab`
+==============
+
+.. automodule:: logilab
+   :members:
+
+
+
+:mod:`rql`
+==========
+
+.. automodule:: rql
+   :members:
+
+:mod:`yams`
+===========
+
+.. automodule:: yams
+   :members: