[pygccxml-commit] SF.net SVN: pygccxml:[1655] pyplusplus_dev/docs
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2009-02-03 19:30:39
|
Revision: 1655 http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1655&view=rev Author: roman_yakovenko Date: 2009-02-03 19:30:36 +0000 (Tue, 03 Feb 2009) Log Message: ----------- sphinx Modified Paths: -------------- pygccxml_dev/docs/example/example.rest pygccxml_dev/pygccxml/declarations/algorithm.py pygccxml_dev/pygccxml/declarations/templates.py pyplusplus_dev/docs/comparisons/pyste.rest pyplusplus_dev/docs/documentation/functions/transformation/inout.rest pyplusplus_dev/docs/documentation/functions/transformation/terminology.rest pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest pyplusplus_dev/docs/documentation/how_to/best_practices.rest pyplusplus_dev/docs/documentation/how_to/exception_translation.rest pyplusplus_dev/docs/documentation/how_to/fatal_error_c1204.rest pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest pyplusplus_dev/docs/documentation/tutorials/tutorials.rest pyplusplus_dev/docs/examples/examples.rest pyplusplus_dev/docs/history/history.rest Modified: pygccxml_dev/docs/example/example.rest =================================================================== --- pygccxml_dev/docs/example/example.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pygccxml_dev/docs/example/example.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -2,7 +2,7 @@ Example ======= -This example prints all declarations found in `example.hpp <./example.hpp.html>`_ +This example prints all declarations found in :doc:`example.hpp <example.hpp>` file. For every class, it prints it's base and derived classes. @@ -12,7 +12,7 @@ .. toctree:: :maxdepth: 1 - C++ source code, this file was passed to GCC-XML <example.hpp.rest> - GCC-XML generated file <example.hpp.xml.rest> - :mod:`pygccxml` package API usage example <example.py.rest> - `example.py` output <output.txt.rest> + example.hpp.rest + example.hpp.xml.rest + example.py.rest + output.txt.rest Modified: pygccxml_dev/pygccxml/declarations/algorithm.py =================================================================== --- pygccxml_dev/pygccxml/declarations/algorithm.py 2009-02-02 22:06:53 UTC (rev 1654) +++ pygccxml_dev/pygccxml/declarations/algorithm.py 2009-02-03 19:30:36 UTC (rev 1655) @@ -308,7 +308,7 @@ class visit_function_has_not_been_found_t( RuntimeError ): """ - exception that is raised, from :function:`apply_visitor`, when a visitor could not be + exception that is raised, from :func:`apply_visitor`, when a visitor could not be applied. """ Modified: pygccxml_dev/pygccxml/declarations/templates.py =================================================================== --- pygccxml_dev/pygccxml/declarations/templates.py 2009-02-02 22:06:53 UTC (rev 1654) +++ pygccxml_dev/pygccxml/declarations/templates.py 2009-02-03 19:30:36 UTC (rev 1655) @@ -12,7 +12,7 @@ - name ( std::vector ) - list of arguments ( int ) -This module also defines few convenience function like :function:split and :function:join. +This module also defines few convenience function like :func:split and :func:join. """ import pattern_parser Modified: pyplusplus_dev/docs/comparisons/pyste.rest =================================================================== --- pyplusplus_dev/docs/comparisons/pyste.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/comparisons/pyste.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -216,10 +216,8 @@ modify\\create `Pyste`_ interface files. They are solved by :doc:`pygccxml <../../pygccxml/pygccxml>` package. Please take a look on :doc:`pygccxml <../../pygccxml/pygccxml>` - `query interface`__ documentation. + :doc:`query interface <../../pygccxml/query_interface>` documentation. -.. __ : ./../../pygccxml/query_interface.html - Now about mistakes. There is a gold rule: one class, one responsibility. `Pyste`_ breaks this rule. One more time *Exporter* class responsibilities: Modified: pyplusplus_dev/docs/documentation/functions/transformation/inout.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/inout.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/functions/transformation/inout.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -6,7 +6,7 @@ Definition ---------- -``inout`` transformer is a combination of `input`_ and `output`_ transformers. +``inout`` transformer is a combination of :doc:`input <inout>` and :doc:`output <output>` transformers. It removes a "reference" type from the function argument and then adds the "returned", by the original function, value to the return statement of the function-wrapper. @@ -15,9 +15,6 @@ argument. The argument should have "reference" type. Support for "pointer" type will be added pretty soon. -.. _`input` : input.html -.. _`output` : output.html - ------- Example ------- Modified: pyplusplus_dev/docs/documentation/functions/transformation/terminology.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/terminology.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/functions/transformation/terminology.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -29,7 +29,6 @@ Name under which `Python`_ users see the exposed function -.. _`Py++` : ./../../../pyplusplus.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/functions/transformation/transformation.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -101,11 +101,9 @@ version of :doc:`Py++ <../../../pyplusplus>`. If you created your own transformer consider to contribute it to the project. -I suggest you to start reading `output`_ transformer. It is pretty simple and +I suggest you to start reading :doc:`output <output>` transformer. It is pretty simple and well explained. -.. _`output` : ./output.html - All built-in transformers could be applied on any function, except constructors and pure virtual functions. The support for them be added in future releases. Modified: pyplusplus_dev/docs/documentation/how_to/best_practices.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -19,10 +19,8 @@ First of all, let me to define "big project". "Big project" is a project with few hundred of header files. :doc:`Py++ <../../pyplusplus>` was born to create `Python`_ bindings -for such projects. If you take a look `here`__ you will find few such projects. +for such projects. If you take a look :doc:`here <../../quotes>` you will find few such projects. -.. __ : ./../../quotes.html - Tips ---- @@ -35,7 +33,8 @@ `GCC-XML`_ processing time from multiple hours with gigabytes of caches to a couple minutes with a reasonable cache size. - You can read more about different caches supported by :doc:`pygccxml <../../../pygccxml/pygccxml>` `here`__. + You can read more about different caches supported by :doc:`pygccxml <../../../pygccxml/pygccxml>` + :doc:`here <../../../pygccxml/design>`. ``module_builder_t.__init__`` method takes reference to an instance of cache class or ``None``: @@ -107,7 +106,6 @@ mb = module_builder( [ os.path.abspath('date_time/date_time.hpp') ], ... ) .. _`this error` : http://boost.org/libs/python/doc/v2/faq.html#c1204 -.. __ : ./../../../pygccxml/design.html * Keep the declaration tree small. Modified: pyplusplus_dev/docs/documentation/how_to/exception_translation.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/exception_translation.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/how_to/exception_translation.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -9,12 +9,10 @@ Boost.Python provides functionality to translate any C++ exception to a Python one. :doc:`Py++ <../../pyplusplus>` provides a convenient API to do this. -By the way, be sure to take a look on "`troubleshooting guide - exceptions`_". +By the way, be sure to take a look on ":doc:`troubleshooting guide - exceptions <../../troubleshooting_guide/exceptions/exceptions>`". The guide will introduces a complete solution for handling exceptions within Python scripts. -.. _`troubleshooting guide - exceptions` : ./../../troubleshooting_guide/exceptions/exceptions.html - -------- Solution -------- Modified: pyplusplus_dev/docs/documentation/how_to/fatal_error_c1204.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/fatal_error_c1204.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/how_to/fatal_error_c1204.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -15,11 +15,9 @@ could not be compiled, because of the error, you can ask :doc:`Py++ <../../pyplusplus>` to split the code generated for class to be split to few source files. -For more information, considre to read the `splitting generated code to files`_ +For more information, considre to read the :doc:`splitting generated code to files <../split_module>` document. -.. _`splitting generated code to files` : ./../split_module.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/how_to/file_name_too_long.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/how_to/file_name_too_long.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -38,9 +38,8 @@ holder.rename( 'IntHolder' ) Another solution to the problem, is to use different strategy to split the generated -code to files. You can read more about splitting files `here`_. +code to files. You can read more about splitting files :doc:`here <../split_module>`. -.. _`here` : ./../split_module.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/tutorials/module_builder/module_builder.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -16,15 +16,12 @@ please take a look on two files: -* `hello_world.hpp`_ - C++ source code, that we want to export to Python +* :doc:`hello_world.hpp <hello_world.hpp>` - C++ source code, that we want to export to Python -* `generate_code.py`_ - Python code, that uses :doc:`Py++ <../../../pyplusplus>` to export +* :doc:`generate_code.py <generate_code.py>` - Python code, that uses :doc:`Py++ <../../../pyplusplus>` to export declarations from the source file -.. _`hello_world.hpp` : ./hello_world.hpp.html -.. _`generate_code.py` : ./generate_code.py.html - ---------------- module_builder_t ---------------- Modified: pyplusplus_dev/docs/documentation/tutorials/tutorials.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/tutorials.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/documentation/tutorials/tutorials.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -16,11 +16,11 @@ ------------------- Graphical interface ------------------- -:doc:`Py++ <../../pyplusplus>` includes a `graphical interface`_. `Graphical interface`_ is invoked +:doc:`Py++ <../../pyplusplus>` includes a :doc:`graphical interface <pyplusplus_gui>`. :doc:`Graphical interface <pyplusplus_gui>` is invoked with the ``pyplusplus_gui`` command, or with ``pyplusplus_gui.pyw`` from the ``scripts`` subdirectory, of the `Python`_ installation directory. -My advise to you - start with `graphical interface`_, because: +My advise to you - start with :doc:`graphical interface <pyplusplus_gui>`, because: * you don't have to learn new API @@ -34,18 +34,13 @@ * it is able to generate :doc:`Py++ <../../pyplusplus>` code for you -.. _`graphical interface` : ./pyplusplus_gui.html -.. _`Graphical interface` : ./pyplusplus_gui.html - --------------- Getting started --------------- -I suppose you decided to do some coding with :doc:`Py++ <../../pyplusplus>`. `Module builder`_ -tutorials will help you. +I suppose you decided to do some coding with :doc:`Py++ <../../pyplusplus>`. +:doc:`Module builder <module_builder/module_builder>` tutorials will help you. -.. _`Module builder` : ./module_builder/module_builder.html - -------- Advanced -------- Modified: pyplusplus_dev/docs/examples/examples.rest =================================================================== --- pyplusplus_dev/docs/examples/examples.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/examples/examples.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -30,12 +30,10 @@ This is not "just another example". I went father and created new package: `pyboost`_. This is fully working Python package, with almost all unit test from -the libraries ported to Python. For more information please read `pyboost`_ +the libraries ported to Python. For more information please read :doc:`pyboost <boost/boost>` package documentation. -.. _`pyboost` : ./boost/boost.html - .. toctree:: boost/boost.rest Modified: pyplusplus_dev/docs/history/history.rest =================================================================== --- pyplusplus_dev/docs/history/history.rest 2009-02-02 22:06:53 UTC (rev 1654) +++ pyplusplus_dev/docs/history/history.rest 2009-02-03 19:30:36 UTC (rev 1655) @@ -150,14 +150,10 @@ for reporting them. 3. New and highly experimental feature was introduced - - `Boost.Python and ctypes integration`_. + :doc:`Boost.Python and ctypes integration <../documentation/ctypes/ctypes_integration>`. -.. _`Boost.Python and ctypes integration` : ../documentation/ctypes/ctypes_integration.html +4. Support for :doc:`boost::python::make_constructor <../documentation/functions/make_constructor>` functionality was added. -4. Support for `boost::python::make_constructor`_ functionality was added. - -.. _`boost::python::make_constructor` : ../documentation/functions/make_constructor.html - 5. Support for unions and unnamed classes was added. 6. Doxygen documentation extractor was improved. Many thanks to Hernán Ordiales. @@ -189,29 +185,23 @@ of ``std::vector< int, std::allocator< int > >``, in many cases :doc:`Py++ <../pyplusplus>` will generate ``std::vector< int >``. -5. `create_with_signature`_ algorithm was improved. :doc:`Py++ <../pyplusplus>` will generate correct - code in one more use case. +5. :doc:`create_with_signature <../documentation/functions/overloading>` algorithm was improved. + :doc:`Py++ <../pyplusplus>` will generate correct code in one more use case. -.. _`create_with_signature` : ../documentation/functions/overloading.html - 6. Added ability to exclude declarations from being exposed, if they will cause compilation to fail. 7. Starting from this version, :doc:`Py++ <../pyplusplus>` provides a complete solution for - `multi-module development`_. + :doc:`multi-module development <../documentation/multi_module_development>`. -.. _`multi-module development` : ../documentation/multi_module_development.html - 8. Classes, which expose C arrays will be registered only once. 9. Starting from this version, :doc:`Py++ <../pyplusplus>` supports a code generation with different encodings. 10. There is a new strategy to split code into files. It is IDE friendly. Be sure - to read `the updated documentation`_. + to read :doc:`the updated documentation <../documentation/split_module>`. -.. _`the updated documentation` : ../documentation/split_module.html - ------------- Version 0.9.0 ------------- @@ -222,16 +212,12 @@ an empty throw was fixed. Now the exception specification is generated properly. Many thanks to Martin Preisler for reporting the bug. -.. line-separator - 2. Added exposing of copy constructor, ``operator=`` and ``operator<<``. * ``operator=`` is exposed under "assign" name * ``operator<<`` is exposed under "__str__" name -.. line-separator - 3. Added new call policies: * :doc:`as_tuple <../documentation/functions/call_policies/as_tuple>` This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |