Revision: 946
http://svn.sourceforge.net/pygccxml/?rev=946&view=rev
Author: roman_yakovenko
Date: 2007-03-05 01:43:54 -0800 (Mon, 05 Mar 2007)
Log Message:
-----------
updating documentation
Modified Paths:
--------------
pyplusplus_dev/docs/documentation/index.rest
Modified: pyplusplus_dev/docs/documentation/index.rest
===================================================================
--- pyplusplus_dev/docs/documentation/index.rest 2007-03-04 20:42:56 UTC (rev 945)
+++ pyplusplus_dev/docs/documentation/index.rest 2007-03-05 09:43:54 UTC (rev 946)
@@ -9,7 +9,7 @@
------------
`Py++`_ documentation is always under active development. It is not an easy
-task to create and maintain it. I will appreciate any help!
+task to create and maintain it. I will appreciate **any help**!
How can you help?
@@ -25,6 +25,75 @@
* Do you think, that the documentation is not clear, I will be glad to improve it,
just point me to the place.
+
+--------
+Overview
+--------
+
+* `API docs`_ - contains API documentation, including source code, generated by `epydoc`_
+
+.. _`API docs` : ./apidocs/index.html
+.. _`epydoc` : http://epydoc.sourceforge.net/
+
+* `STL containers`_ - describes various methods to expose STL containers to `Python`_
+
+.. _`STL containers` : ./containers.html
+
+* `architecture`_ - describes the architecture behind `Py++`_
+
+.. _`architecture` : ./architecture.html
+
+* `best practices`_ - `Py++`_ is huge, this document will explain you how to
+ effectively use it
+
+.. _`best practices`: ./best_practices.html
+
+* `documentation string`_ - explains how to automaticly extract a documentation
+ from the source files and put it as Python documentation string
+
+.. _`documentation string` : ./doc_string.html
+
+* `feedback`_ - `Py++`_ could be used as some kind of validator. It checks the
+ exposed declarations and reports the potential errors. Thus you are able to
+ create high quality Python bindings from the beginning. This document also
+ describes how to supress the errors\\warnings.
+
+.. _`feedback` : ./feedback.html
+
+* `functions & operators`_ - contains a complete guide to exposing functions and
+ operators, including "call policies" and description of different caveats
+
+.. _`functions & operators` : ../functions/functions.html
+
+* `hints`_ - describes few techinques, which will help you with exposing template
+ instantiations
+
+.. _`hints`: ./hints.html
+
+* `how to ... ?`_ - contains answers for different frequently asked questions
+
+.. _`how to ... ?` : ./how_to.html
+
+* `inserting code`_ - a complete guide for insert your code into the generated one
+
+.. _`inserting code` : ./inserting_code.html
+
+* `multi-module development`_ - describes how expose hierarchy of classes, which
+ is spread few different libraries
+
+.. _`multi-module development`: ./multi_module_development.html
+
+* `properties`_ - describes how to create class properties using `Py++`_ and
+ built-in algorithm for automatic properties recognition
+
+.. _`properties`: ./properties.html
+
+* `tutorials`_ - don't know where to start? Start here. Small and simple example
+ will help you to start with `Py++`_. If you want to evaluate `Py++`_ you will
+ find here small and handy GUI program.
+
+.. _`tutorials` : ./tutorials/tutorials.html
+
.. _`Epydoc` : http://epydoc.sourceforge.net/
.. _`Py++` : ./../pyplusplus.html
.. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
