2691: Create api documentation with sphinx

svn: r12704
2009-06-24 21:56:07 +00:00
parent 1042bb3fe2
commit a52bc62be9
68 changed files with 2203 additions and 1161 deletions
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -0,0 +1,42 @@
+##################
+Code Documentation
+##################
+
+*GRAMPS* provides several general API. The most important is the *gen* module, providing access to all code that can be of interest outside of the GRAMPS program.
+
+The :mod:`gen` Module
+=======================
+
+.. automodule:: gen
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   gen/gen_lib
+   gen/gen_db
+   gen/gen_proxy
+   gen/gen_utils
+
+The GRAMPS Application
+========================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   corecli/cli
+   coregui/gui
+   utils
+
+Usefull snippets
+===================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   html