[pygccxml-commit] SF.net SVN: pygccxml:[1654] pyplusplus_dev/docs

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 1654
          http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1654&view=rev
Author:   roman_yakovenko
Date:     2009-02-02 22:06:53 +0000 (Mon, 02 Feb 2009)

Log Message:
-----------
sphinx

Modified Paths:
--------------
    pydsc_dev/docs/pydsc.rest
    pygccxml_dev/docs/pygccxml.rest
    pygccxml_dev/docs/upgrade_issues.rest
    pyplusplus_dev/docs/comparisons/compare_to.rest
    pyplusplus_dev/docs/comparisons/pyste.rest
    pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest
    pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest
    pyplusplus_dev/docs/documentation/functions/call_policies/return_range.rest
    pyplusplus_dev/docs/documentation/functions/overloading.rest
    pyplusplus_dev/docs/documentation/index.rest
    pyplusplus_dev/docs/examples/examples.rest
    pyplusplus_dev/docs/history/history.rest
    pyplusplus_dev/docs/troubleshooting_guide/automatic_conversion/automatic_conversion.rest
    pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest
    pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest
    pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest

Modified: pydsc_dev/docs/pydsc.rest
===================================================================

--- pydsc_dev/docs/pydsc.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pydsc_dev/docs/pydsc.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -24,7 +24,7 @@
 What it is useful for?
 ----------------------
 
-The `pydsc`_ module checks documentation strings and comments for spelling errors.
+The :mod:`pydsc <pydsc>` module checks documentation strings and comments for spelling errors.
 
 Usage example
 -------------
@@ -76,5 +76,4 @@
 python setup.py install
 
 
-.. _`pydsc`: ./pydsc.html
 .. _`PyEnchant`: http://pyenchant.sourceforge.net/

Modified: pygccxml_dev/docs/pygccxml.rest
===================================================================
--- pygccxml_dev/docs/pygccxml.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pygccxml_dev/docs/pygccxml.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -56,15 +56,13 @@
 
 ``None`` means "any type". In my opinion, the code is prety clear and readable.
 
-If you want to know more about provided API read `query interface`__ document or
-API documentation.
+If you want to know more about provided API read :doc:`query interface <query_interface>`
+document or :doc:`API documentation <apidocs/api>`
 
-.. __: ./query_interface.html
-
 Type traits
 -----------
 :doc:`pygccxml <pygccxml>` provides a lot of functionality to analyze C++ types and relationship
-between them. For more information please refer to `design`__ document or API
+between them. For more information please refer to :doc:`design <design>` document or API
 documentation. Just a few names of algorithms:
 
 * ``is_convertible( from, to )``
@@ -76,9 +74,7 @@
 
   returns ``True`` if ``oper`` describes unary operator
 
-.. __: ./design.html
 
-
 Declaration dependencies
 ------------------------
 You can query a declaration, about it dependencies - declarations it depends on.

Modified: pygccxml_dev/docs/upgrade_issues.rest
===================================================================
--- pygccxml_dev/docs/upgrade_issues.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pygccxml_dev/docs/upgrade_issues.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -20,12 +20,9 @@
 an implicit ones.
 
 If you rely heavily on their existence in the generated XML, I suggest you to switch
-to `type_traits.has_trivial_constructor`_/`type_traits.has_trivial_copy`_ functions.
+to :func:`has_trivial_constructor <pygccxml.declarations.type_traits.has_trivial_constructor>`
+and to :func:`has_trivial_copy <pygccxml.declarations.type_traits.has_copy_constructor>` functions.
 
-.. _`type_traits.has_trivial_constructor` : ./apidocs/pygccxml.declarations.type_traits-pysrc.html#has_trivial_constructor
-.. _`type_traits.has_trivial_copy` : ./apidocs/pygccxml.declarations.type_traits-pysrc.html#has_trivial_copy
-
-
 --------------------------
 Pointer to member variable
 --------------------------

Modified: pyplusplus_dev/docs/comparisons/compare_to.rest
===================================================================
--- pyplusplus_dev/docs/comparisons/compare_to.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/comparisons/compare_to.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -8,10 +8,8 @@
 
 `Pyste`_ is the Boost.Python code generator, which is not under active development
 any more. Nevertheless, users request to compare :doc:`Py++ <../pyplusplus>` and `Pyste`_. You
-can read `here`_ the comparison.
+can read :doc:`here <pyste>` the comparison.
 
-.. _`here` : ./pyste.html
-
 ----------
 SWIG & SIP
 ----------

Modified: pyplusplus_dev/docs/comparisons/pyste.rest
===================================================================
--- pyplusplus_dev/docs/comparisons/pyste.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/comparisons/pyste.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -103,7 +103,7 @@
 
     1. GUI - small and simple graphic user interface, which does not request from
        user any knowledge about `Boost.Python`_ or :doc:`Py++ <../pyplusplus>`. You can see
-       its `screenshot`_.
+       its :doc:`screenshot <../documentation/tutorials/pyplusplus_gui>`.
 
     2. API - object-oriented framework, that helps you to create code generator,
        that suites your needs. :doc:`Py++ <../pyplusplus>` framework consists 3 packages:
@@ -422,7 +422,6 @@
 thought about them, long before I created :doc:`Py++ <../pyplusplus>`. But unfortunately, lack
 of time and motivation prevents him to work on `Pyste`_.
 
-.. _`screenshot` : ./../documentation/tutorials/pyplusplus_gui.html
 .. _`Pyste`: http://www.boost.org/libs/python/doc/index.html
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`SourceForge`: http://sourceforge.net/index.php

Modified: pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest
===================================================================
--- pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -67,7 +67,7 @@
 
 * expose variable, which has a union type
 
-* return address of return value as integer - `new call policy was created`_
+* return address of return value as integer - :doc:`new call policy was created <../../documentation/functions/call_policies/return_addressof>`
 
 ---------------------------
 ctypes integration contents
@@ -90,7 +90,6 @@
 
 * to add ability to expose "C" functions without using `Boost.Python`_.
 
-.. _`new call policy was created` : ./../../documentation/functions/call_policies/return_addressof.html
 .. _`ctypes` : http://docs.python.org/lib/module-ctypes.html
 .. _`from_address` : http://docs.python.org/lib/ctypes-data-types.html
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html

Modified: pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest
===================================================================
--- pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -196,12 +196,9 @@
    return_range.rest
    custom_call_policies.rest
 
-.. _`new indexing suite` : ./../../containers.html
-.. _`this file` : http://pygccxml.svn.sourceforge.net/viewvc/pygccxml/pyplusplus_dev/pyplusplus/code_repository/call_policies.py?view=markup
 
 .. _`ResultConverterGenerator` : http://boost.org/libs/python/doc/v2/ResultConverter.html#ResultConverterGenerator-concept
 .. _`CallPolicies` : http://www.boost.org/libs/python/doc/v2/CallPolicies.html#CallPolicies-concept
-
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`Python`: http://www.python.org
 .. _`GCC-XML`: http://www.gccxml.org

Modified: pyplusplus_dev/docs/documentation/functions/call_policies/return_range.rest
===================================================================
--- pyplusplus_dev/docs/documentation/functions/call_policies/return_range.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/documentation/functions/call_policies/return_range.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -215,15 +215,10 @@
 Dependencies
 ~~~~~~~~~~~~
 
-The new call policy depends on `new indexing suite`_ and :doc:`Py++ <../../../pyplusplus>` :-). But if you
-want you can extract the relevant piece of code from `this file`_.
+The new call policy depends on :doc:`new indexing suite <../../containers>` and :doc:`Py++ <../../../pyplusplus>` :-). 
 
-.. _`new indexing suite` : ./../../containers.html
-.. _`this file` : http://pygccxml.svn.sourceforge.net/viewvc/pygccxml/pyplusplus_dev/pyplusplus/code_repository/call_policies.py?view=markup
-
 .. _`ResultConverterGenerator` : http://boost.org/libs/python/doc/v2/ResultConverter.html#ResultConverterGenerator-concept
 .. _`CallPolicies` : http://www.boost.org/libs/python/doc/v2/CallPolicies.html#CallPolicies-concept
-
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`Python`: http://www.python.org
 .. _`GCC-XML`: http://www.gccxml.org

Modified: pyplusplus_dev/docs/documentation/functions/overloading.rest
===================================================================
--- pyplusplus_dev/docs/documentation/functions/overloading.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/documentation/functions/overloading.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -160,11 +160,8 @@
 The default value of the property is ``False``.
 
 You don't really have to use the macros, unless you have "registration order"
-problem. The problem and work around described in `default arguments`_ document.
+problem. The problem and work around described in :doc:`default arguments <default_args>` document.
 
-.. _`default arguments` : ./default_args.html
-
-
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`Python`: http://www.python.org
 .. _`GCC-XML`: http://www.gccxml.org

Modified: pyplusplus_dev/docs/documentation/index.rest
===================================================================
--- pyplusplus_dev/docs/documentation/index.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/documentation/index.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -44,63 +44,6 @@
    functions/functions.rest
    how_to/how_to.rest
 
-* `STL containers`_ - describes various methods to expose STL containers to `Python`_
-
-.. _`STL containers` : ./containers.html
-
-* `architecture`_ - describes the architecture behind :doc:`Py++ <../pyplusplus>`
-
-.. _`architecture` : ./architecture.html
-
-* `documentation string`_ - explains how to automatically extract a documentation
-  from the source files and put it as Python documentation string
-
-.. _`documentation string` : ./doc_string.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
-
-* `how to ... ?`_ - contains answers for different FAQs and my suggestions about
-  better :doc:`Py++ <../pyplusplus>` usage.
-
-.. _`how to ... ?` : ./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 :doc:`Py++ <../pyplusplus>` and
-  built-in algorithm for automatic properties recognition
-
-.. _`properties`: ./properties.html
-
-* `splitting generated code to files`_ - :doc:`Py++ <../pyplusplus>` provides 4 different strategies
-   for splitting the generated code into files. Take a look on this document,
-   it will save you the time.
-
-.. _`splitting generated code to files` : ./split_module.html
-
-* `tutorials`_ - don't know where to start? Start here. Small and simple example
-  will help you to start with :doc:`Py++ <../pyplusplus>`. If you want to evaluate :doc:`Py++ <../pyplusplus>` you will
-  find here small and handy GUI program.
-
-.. _`tutorials` : ./tutorials/tutorials.html
-
-* `warnings`_ - :doc:`Py++ <../pyplusplus>` 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 suppress the errors\\warnings.
-
-.. _`warnings` : ./warnings.html
-
-
 .. _`epydoc` : http://epydoc.sourceforge.net/
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
 .. _`Python`: http://www.python.org

Modified: pyplusplus_dev/docs/examples/examples.rest
===================================================================
--- pyplusplus_dev/docs/examples/examples.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/examples/examples.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -5,23 +5,17 @@
 Graphical interface
 -------------------
 
+:doc:`Py++ <../pyplusplus>` has nice, small and simple :doc:`graphical interface <../documentation/tutorials/pyplusplus_gui>`. 
+Consider to read :doc:`tutorials <../documentation/tutorials/tutorials>` for more information.
 
-:doc:`Py++ <../pyplusplus>` has nice, small and simple `graphical interface`_. Please, read
-`tutorials`_ for more information.
-
-.. _`graphical interface` : ./../documentation/tutorials/pyplusplus_gui.html
-.. _`tutorials` : ./../documentation/tutorials/tutorials.html
-
 ---------
 pyeasybmp
 ---------
 
-`EasyBMP`_ is a small cross-platform library that provide you functionality
+:doc:`EasyBMP <easybmp/easybmp>` is a small cross-platform library that provide you functionality
 needed to work with Windows bitmap (BMP) image files. I took me only few minutes
-to create Python bindings for the library. Read more `here`__.
+to create Python bindings for the library. Read more :doc:`here <easybmp/easybmp>`.
 
-..  __ : ./easybmp/easybmp.html
-
 ---------------
 boost libraries
 ---------------
@@ -51,8 +45,5 @@
 .. _`boost.crc` : http://boost.org/libs/crc/index.html
 .. _`boost.rational` : http://boost.org/libs/rational/index.html
 .. _`boost.random` : http://boost.org/libs/random/index.html
-
-.. _`GUI`: ./../tutorials/pyplusplus_demo.png
 .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
-.. _`EasyBMP`: http://easybmp.sourceforge.net/
 

Modified: pyplusplus_dev/docs/history/history.rest
===================================================================
--- pyplusplus_dev/docs/history/history.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/history/history.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -234,29 +234,21 @@
 
 3. Added new call policies:
 
-   * `as_tuple`_
+   * :doc:`as_tuple <../documentation/functions/call_policies/as_tuple>`
 
-   * `custom_call_policies`_
+   * :doc:`custom_call_policies <../documentation/functions/call_policies/return_range>`
 
-   * `return_range`_
+   * :doc:`return_range <../documentation/functions/call_policies/return_range>`
 
-.. _`as_tuple` : ../documentation/functions/call_policies/as_tuple.html
-.. _`return_range`: ../documentation/functions/call_policies/return_range.html
-.. _`custom_call_policies` : ../documentation/functions/call_policies/custom_call_policies.html
-
 4. Added an initial support for multi-module development. Now you can mark your
    declarations as ``already_exposed`` and :doc:`Py++ <../pyplusplus>` will do the rest. For more
-   information read `multi-module development guide`_.
+   information read :doc:`multi-module development guide <../documentation/multi_module_development>`.
 
-.. _`multi-module development guide` : ../documentation/multi_module_development.html
-
 .. line-separator
 
-5. `input_c_buffer`_ - new functions transformation, which allows to pass a Python
-   sequence to function, instead of pair of arguments: pointer to buffer and size.
+5. :doc:`input_c_buffer <../documentation/functions/transformation/input_c_buffer>` - new functions 
+   transformation, which allows to pass a Python sequence to function, instead of pair of arguments: pointer to buffer and size.
 
-.. _`input_c_buffer` : ../documentation/functions/transformation/input_c_buffer.html
-
 6. Added ability to control generated "include" directives. Now you can ask :doc:`Py++ <../pyplusplus>`
    to include a header file, when it generates code for some declaration. For more
    information refers to `inserting code guide`_.
@@ -267,22 +259,16 @@
    will be included from the generated files only in case the generated code
    depends on them.
 
-.. line-separator
-
 8. Performance improvements: Py++ runs 1.5 - 2 times faster, than the previous one.
 
-.. line-separator
-
 9. Added ability to add code before overridden and default function calls.
    For more information refer to `member function API documentation`_.
 
 .. _`member function API documentation` : ../documentation/apidocs/pyplusplus.decl_wrappers.calldef_wrapper.member_function_t-class.html
 
 10. :doc:`Py++ <../pyplusplus>` will generate documentation for automatically constructed properties.
-    For more information refer to `properties guide`_
+    For more information refer to :doc:`properties guide <../documentation/properties>`.
 
-.. _`properties guide`: ../documentation/properties.html#documentation
-
 11. Added iteration functionality to Boost.Python Indexing Suite V2 ``std::map``
     and ``std::multimap`` containers.
 
@@ -290,24 +276,17 @@
 Version 0.8.5
 -------------
 
-1. Added `Function Transformation`_ feature.
+1. Added :doc:`Function Transformation <../documentation/functions/transformation/transformation>` feature.
 
-.. _`Function transformation` : ../documentation/functions/transformation/transformation.html
-
 2. "Py++" introduces new functionality, which allows you to control messages and
-   warnings: `how to disable warnings?`_ .
+   warnings: :doc:`how to disable warnings? <../documentation/warnings>`.
 
-.. _`how to disable warnings?` : ../documentation/warnings.html
-
 3. Added new algorithm, which controls the registration order of the functions.
-   See `registration order document`_
+   See :doc:`registration order document <../documentation/functions/registration_order>`
 
-.. _`registration order document` : ../documentation/functions/registration_order.html
+4. New "Py++" defined :doc:`return_pointee_value <../documentation/functions/call_policies/return_pointee_value>` 
+   call policy was introduced.
 
-4. New "Py++" defined `return_pointee_value`_ call policy was introduced.
-
-.. _`return_pointee_value` : ../documentation/functions/call_policies/return_pointee_value.html
-
 5. Support for opaque types was added. Read more about this feature `here`__.
 
 .. __ : ../documentation/functions/call_policies/call_policies.html#special-case
@@ -337,7 +316,7 @@
 
 2. Performance improvements. In some cases you can get x10 performance boost.
    Many thanks to Allen Bierbaum! Saving and reusing results of different
-   :doc:`pygccxml <../pygccxml>` algorithms and type traits functions achieved this.
+   :doc:`pygccxml <../../pygccxml/pygccxml>` algorithms and type traits functions achieved this.
 
 3. Convenience API for registering exception translator was introduced.
 

Modified: pyplusplus_dev/docs/troubleshooting_guide/automatic_conversion/automatic_conversion.rest
===================================================================
--- pyplusplus_dev/docs/troubleshooting_guide/automatic_conversion/automatic_conversion.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/troubleshooting_guide/automatic_conversion/automatic_conversion.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -38,6 +38,4 @@
 Download
 --------
 
-`automatic_conversion.zip`_
-
-.. _`automatic_conversion.zip` : ./automatic_conversion.zip
+:download:`automatic_conversion.zip`

Modified: pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest
===================================================================
--- pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/troubleshooting_guide/exceptions/exceptions.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -57,7 +57,5 @@
 Download
 --------
 
-`exceptions.zip`_
+:download:`exceptions.zip`
 
-.. _`exceptions.zip` : ./exceptions.zip
-

Modified: pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest
===================================================================
--- pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -73,7 +73,5 @@
 Download
 --------
 
-`shared_ptr.zip`_
+:download:`shared_ptr.zip`
 
-.. _`shared_ptr.zip` : ./shared_ptr.zip
-

Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest
===================================================================
--- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest	2009-02-02 21:09:57 UTC (rev 1653)
+++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest	2009-02-02 22:06:53 UTC (rev 1654)
@@ -25,10 +25,7 @@
 Download
 --------
 
-`smart_ptrs.zip`_
+:download:`smart_ptrs.zip`
 
-.. _`smart_ptrs.zip` : ./smart_ptrs.zip
-
-
 .. _`SourceForge`: http://sourceforge.net/index.php
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


