[pygccxml-commit] SF.net SVN: pygccxml:[1647] pyplusplus_dev/docs
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2009-02-01 20:00:49
|
Revision: 1647 http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1647&view=rev Author: roman_yakovenko Date: 2009-02-01 20:00:45 +0000 (Sun, 01 Feb 2009) Log Message: ----------- sphinx Modified Paths: -------------- pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest pyplusplus_dev/docs/documentation/functions/functions.rest pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest pyplusplus_dev/docs/documentation/how_to/how_to.rest pyplusplus_dev/docs/documentation/index.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/generate_code.py.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/generated.cpp.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/hello_world.hpp.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest pyplusplus_dev/docs/documentation/tutorials/tutorials.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/bindings.cpp.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/classes.hpp.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/sconstruct.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptr.h.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/test.py.rest Added Paths: ----------- pyplusplus_dev/docs/documentation/apidocs/api.rest pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest Removed Paths: ------------- pyplusplus_dev/docs/comparisons/www_configuration.py pyplusplus_dev/docs/documentation/apidocs/www_configuration.py pyplusplus_dev/docs/documentation/ctypes/www_configuration.py pyplusplus_dev/docs/documentation/easy_extending_guide.odt pyplusplus_dev/docs/documentation/functions/call_policies/www_configuration.py pyplusplus_dev/docs/documentation/functions/transformation/www_configuration.py pyplusplus_dev/docs/documentation/functions/www_configuration.py pyplusplus_dev/docs/documentation/how_to/www_configuration.py pyplusplus_dev/docs/documentation/indexing_suite_v2_files/www_configuration.py pyplusplus_dev/docs/documentation/tutorials/module_builder/www_configuration.py pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest pyplusplus_dev/docs/documentation/tutorials/www_configuration.py pyplusplus_dev/docs/documentation/www_configuration.py pyplusplus_dev/docs/examples/boost/www_configuration.py pyplusplus_dev/docs/examples/easybmp/www_configuration.py pyplusplus_dev/docs/osdc2006/www_configuration.py pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/www_configuration.py pyplusplus_dev/docs/troubleshooting_guide/www_configuration.py pyplusplus_dev/docs/tutorials.rest Deleted: pyplusplus_dev/docs/comparisons/www_configuration.py =================================================================== --- pyplusplus_dev/docs/comparisons/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/comparisons/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,5 +0,0 @@ -name = 'compare to ...' -main_html_file = 'compare_to.html' -names = { 'compare_to' : 'compare to ...' - , 'pyste' : 'Pyste' -} \ No newline at end of file Added: pyplusplus_dev/docs/documentation/apidocs/api.rest =================================================================== --- pyplusplus_dev/docs/documentation/apidocs/api.rest (rev 0) +++ pyplusplus_dev/docs/documentation/apidocs/api.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -0,0 +1,9 @@ +=== +API +=== + +`Py++` consists from XXX sub packages + +.. toctree:: + :maxdepth: 4 + Deleted: pyplusplus_dev/docs/documentation/apidocs/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/apidocs/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/apidocs/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +0,0 @@ -name = 'API docs' -main_html_file = 'index.html' \ No newline at end of file Modified: pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest =================================================================== --- pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/ctypes/ctypes_integration.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -19,7 +19,6 @@ compatible data types, and allows to call functions in dlls/shared libraries. It can be used to wrap these libraries in pure Python. - -------- The idea -------- @@ -70,6 +69,16 @@ * return address of return value as integer - `new call policy was created`_ +--------------------------- +ctypes integration contents +--------------------------- + +.. toctree:: + + variables.rest + this_and_sizeof.rest + unions.rest + ----------------- Future directions ----------------- Deleted: pyplusplus_dev/docs/documentation/ctypes/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/ctypes/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/ctypes/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,6 +0,0 @@ -name = 'ctypes integration' -main_html_file = 'ctypes_integration.html' - -names = { 'ctypes_integration' : 'ctypes integration' - , 'this_and_sizeof' : 'this & sizeof'} - Deleted: pyplusplus_dev/docs/documentation/easy_extending_guide.odt =================================================================== (Binary files differ) Modified: pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/call_policies/call_policies.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -184,9 +184,18 @@ -------------------------- `Py++`_ defines few call policies. I hope you will find them useful. I don't mind -to contribute them to `Boost.Python`_ library, but I don't have enough free time +to contribute them to `Boost.Python`_ library, but I don't have enough free time to "boostify" them. + +.. toctree:: + + as_tuple.rest + return_addressof.rest + return_pointee_value.rest + 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 Deleted: pyplusplus_dev/docs/documentation/functions/call_policies/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/functions/call_policies/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/call_policies/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,6 +0,0 @@ -name = 'call policies' -#main_html_file = 'index.html' - -names = { 'call_policies' : 'call policies' -} - Modified: pyplusplus_dev/docs/documentation/functions/functions.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/functions.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/functions.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -10,7 +10,20 @@ This section of documentation will explain how to configure `Py++`_ in order to export your functions, using desired `Boost.Python`_ functionality. +-------- +Contents +-------- +.. toctree:: + + call_policies/call_policies.rest + transformation/transformation.rest + default_args.rest + make_constructor.rest + overloading.rest + registration_order.rest + + .. _`Py++` : ./../../pyplusplus.html .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html .. _`Python`: http://www.python.org Modified: pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -6,11 +6,11 @@ Introduction ------------ -During the development of `Python`_ bindings for some C++ library, it might get -necessary to write custom wrapper code for a particular function in order to +During the development of `Python`_ bindings for some C++ library, it might get +necessary to write custom wrapper code for a particular function in order to make that function usable from `Python`_. -An often mentioned example that demonstrates the problem is the ``get_size()`` +An often mentioned example that demonstrates the problem is the ``get_size()`` member function of a fictitious image class: .. code-block:: c++ @@ -18,9 +18,9 @@ void get_size(int& width, int& height); This member function cannot be exposed with standard `Boost.Python`_ mechanisms. -The main reasons for this is that ``int`` is immutable type in `Python`_. -An instance of immutable type could not be changed after construction. The only -way to expose this function to `Python`_ is to create small wrapper, which will +The main reasons for this is that ``int`` is immutable type in `Python`_. +An instance of immutable type could not be changed after construction. The only +way to expose this function to `Python`_ is to create small wrapper, which will return a tuple. In `Python`_, the above function would instead be invoked like this: .. code-block:: python @@ -37,67 +37,66 @@ img.get_size( width, height ); return boost::python::make_tuple( width, height ); } - -As you can see this function is simply invokes the original ``get_size()`` member + +As you can see this function is simply invokes the original ``get_size()`` member function and return the output values as a tuple. -Unfortunately, C++ source code cannot describe the semantics of an argument so -there is no way for a code generator tool such as `Py++`_ to know whether an -argument that has a reference type is actually an output argument, an input -argument or an input/output argument. That's why the user will always have to -"enhance" the C++ code and tell the code generator tool about the missing -information. +Unfortunately, C++ source code cannot describe the semantics of an argument so +there is no way for a code generator tool such as `Py++`_ to know whether an +argument that has a reference type is actually an output argument, an input +argument or an input/output argument. That's why the user will always have to +"enhance" the C++ code and tell the code generator tool about the missing +information. Note: C++ fundamental types, enumerations and string are all mapped to `Python`_ immutable types. -Instead of forcing you to write the entire wrapper function, `Py++`_ allows you -to provide the semantics of an argument(s) and then it will take care of +Instead of forcing you to write the entire wrapper function, `Py++`_ allows you +to provide the semantics of an argument(s) and then it will take care of producing the correct code: .. code-block:: python from pyplusplus import module_builder from pyplusplus import function_transformers as FT - + mb = module_builder.module_builder_t( ... ) get_size = mb.mem_fun( 'image_t::get_size' ) get_size.add_transformation( FT.output(0), FT.output(1) ) #the following line has same effect get_size.add_transformation( FT.output('width'), FT.output('height') ) -`Py++`_ will generate a code, very similar to one found in +`Py++`_ will generate a code, very similar to one found in ``boost::python::tuple get_size( const image_t& img )`` function. --------- -Thanks to +Thanks to --------- A thanks goes to Matthias Baas for his efforts and hard work. He did a research, -implemented the initial working version and wrote a lot of documentation. +implemented the initial working version and wrote a lot of documentation. --------------------- -Built-in transformers +Transformers contents --------------------- `Py++`_ comes with few predefined transformers: -* ``output`` +.. toctree:: -* ``input`` + terminology.rest + Generated functions name <name_mangling.rest> + output.rest + input.rest + inout.rest + modify_type.rest + input_static_array.rest + output_static_array.rest + transfer_ownership.rest + input_c_buffer.rest -* ``inout`` -* ``modify_type`` -* ``input_static_array`` - -* ``output_static_array`` - -* ``input_c_buffer`` - -* ``transfer_ownership`` - The set doesn't cover all common use cases, but it will grow with every new version of `Py++`_. If you created your own transformer consider to contribute it to the project. Deleted: pyplusplus_dev/docs/documentation/functions/transformation/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/transformation/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,6 +0,0 @@ -name = 'function transformation' -#main_html_file = 'index.html' - -names = { 'built_in_transformers' : 'built-in transformers' - , 'name_mangling' : 'name mangling' -} Deleted: pyplusplus_dev/docs/documentation/functions/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/functions/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/functions/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,7 +0,0 @@ -name = 'functions & operators' -#main_html_file = 'index.html' - -names = { 'call_policies' : 'call policies' - , 'default_args' : 'default arguments' - , 'registration_order' : 'registration order' -} Modified: pyplusplus_dev/docs/documentation/how_to/how_to.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to/how_to.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/how_to/how_to.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -2,28 +2,12 @@ How to ... ? ============ -`How to deal with templates?`_ +.. toctree:: -.. _`How to deal with templates?` : ./templates.html - -`How to register an exception translation?`_ - -.. _`How to register an exception translation?` : exception_translation.html - -`Fatal error C1204:Compiler limit: internal structure overflow`_ - -.. _`Fatal error C1204:Compiler limit: internal structure overflow` : ./fatal_error_c1204.html - -`Absolute\\relative paths`_ - -.. _`Absolute\\relative paths` : ./absolute_relative_paths.html - -`Generated file name is too long`_ - -.. _`Generated file name is too long` : ./file_name_too_long.html - - -.. _`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 + templates.rest + exception_translation.rest + fatal_error_c1204.rest + absolute_relative_paths.rest + file_name_too_long.rest + best_practices.rest + hints.rest Deleted: pyplusplus_dev/docs/documentation/how_to/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/how_to/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/how_to/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,13 +0,0 @@ -name = 'how to ... ?' -#main_html_file = 'index.html' - -names = { 'hints' : 'hints' - , 'how_to' : 'how to' - , 'templates' : 'deal with templates' - , 'best_practices' : 'best practices' - , 'exception_translation' : 'exception translation' - , 'fatal_error_c1204' : 'fatal error: C1204' - , 'absolute_relative_paths' : 'absolute\\relative paths' - , 'file_name_too_long' : 'file name is too long' -} - Modified: pyplusplus_dev/docs/documentation/index.rest =================================================================== --- pyplusplus_dev/docs/documentation/index.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/index.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -28,10 +28,21 @@ Overview -------- -* `API docs`_ - contains API documentation, including source code, generated by `epydoc`_ +.. toctree:: -.. _`API docs` : ./apidocs/index.html -.. _`epydoc` : http://epydoc.sourceforge.net/ + tutorials/tutorials.rest + architecture.rest + apidocs/api.rest + containers.rest + doc_string.rest + multi_module_development.rest + properties.rest + split_module.rest + warnings.rest + inserting_code.rest + ctypes/ctypes_integration.rest + functions/functions.rest + how_to/how_to.rest * `STL containers`_ - describes various methods to expose STL containers to `Python`_ @@ -70,12 +81,12 @@ .. _`properties`: ./properties.html -* `splitting generated code to files`_ - `Py++`_ provides 4 different strategies - for splitting the generated code into files. Take a look on this document, +* `splitting generated code to files`_ - `Py++`_ 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 `Py++`_. If you want to evaluate `Py++`_ you will find here small and handy GUI program. Deleted: pyplusplus_dev/docs/documentation/indexing_suite_v2_files/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/indexing_suite_v2_files/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/indexing_suite_v2_files/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1 +0,0 @@ -expose_to_web = False \ No newline at end of file Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/generate_code.py.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/generate_code.py.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/generate_code.py.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +================================ +`module_builder_t` usage example +================================ + .. literalinclude:: ./generate_code.py :language: python Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/generated.cpp.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/generated.cpp.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/generated.cpp.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +============== +Generated code +============== + .. literalinclude:: ./generated.cpp :language: c++ Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/hello_world.hpp.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/hello_world.hpp.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/hello_world.hpp.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +=============== +C++ header file +=============== + .. literalinclude:: ./hello_world.hpp :language: c++ Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -149,13 +149,15 @@ For big projects it is a must to minimize compilation time. So `Py++`_ splits your module source code to different files within the directory. ------- -Result ------- +----- +Files +----- -`View generated file`_ +.. toctree:: -.. _`View generated file` : ./generated.cpp.html + hello_world.hpp.rest + generate_code.py.rest + generated.cpp.rest That's all. I hope you enjoyed. Deleted: pyplusplus_dev/docs/documentation/tutorials/module_builder/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1 +0,0 @@ -name = 'module builder' \ No newline at end of file Deleted: pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1 +0,0 @@ -.. image:: pyplusplus_gui.png Added: pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest (rev 0) +++ pyplusplus_dev/docs/documentation/tutorials/pyplusplus_gui.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -0,0 +1,5 @@ +===================== +pygccxml and Py++ GUI +===================== + +.. image:: pyplusplus_gui.png Modified: pyplusplus_dev/docs/documentation/tutorials/tutorials.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/tutorials.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/tutorials.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -2,6 +2,11 @@ tutorials ========= +.. toctree:: + + module_builder/module_builder.rest + pyplusplus_gui.rest + ------------- What is Py++? ------------- Deleted: pyplusplus_dev/docs/documentation/tutorials/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/tutorials/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +0,0 @@ -name = 'tutorials' -names = { 'pyplusplus_gui' : 'Py++ - graphical user interface' } Deleted: pyplusplus_dev/docs/documentation/www_configuration.py =================================================================== --- pyplusplus_dev/docs/documentation/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/documentation/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,11 +0,0 @@ -name = 'documentation' -main_html_file = 'index.html' -files_to_skip = ['indexing_suite_v2.html', 'feedback.html'] -names = { 'containers' : 'STL containers' - , 'how_to' : 'how to ... ?' - , 'doc_string' : 'documentation string' - , 'inserting_code' : 'inserting code' - , 'best_practices' : 'best practices' - , 'multi_module_development' : 'multi-module development' - , 'split_module' : 'splitting generated code to files' -} Deleted: pyplusplus_dev/docs/examples/boost/www_configuration.py =================================================================== --- pyplusplus_dev/docs/examples/boost/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/examples/boost/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +0,0 @@ -name = 'boost' -#This directory used as place holder for Py++ directory \ No newline at end of file Deleted: pyplusplus_dev/docs/examples/easybmp/www_configuration.py =================================================================== --- pyplusplus_dev/docs/examples/easybmp/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/examples/easybmp/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1 +0,0 @@ -name = 'EasyBMP' \ No newline at end of file Deleted: pyplusplus_dev/docs/osdc2006/www_configuration.py =================================================================== --- pyplusplus_dev/docs/osdc2006/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/osdc2006/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1 +0,0 @@ -expose_to_web = False \ No newline at end of file Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/bindings.cpp.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/bindings.cpp.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/bindings.cpp.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +======================== +C++/Python bindings code +======================== + .. literalinclude:: ./bindings.cpp :language: c++ Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/classes.hpp.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/classes.hpp.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/classes.hpp.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +========================= +To be exposed C++ classes +========================= + .. literalinclude:: ./classes.hpp :language: c++ Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/sconstruct.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/sconstruct.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/sconstruct.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +==================== +Build script (SCons) +==================== + .. literalinclude:: ./sconstruct :language: python Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptr.h.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptr.h.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptr.h.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +================================== +User defined "smart pointer" class +================================== + .. literalinclude:: ./smart_ptr.h :language: c++ Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/smart_ptrs.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -11,25 +11,16 @@ Files ----- -* `smart_ptr.h`_ file contains definition of custom smart pointer class. +.. toctree:: -* `classes.hpp`_ file contains definition of few classes, which should be exposed - to Python. + smart_ptr.h.rest + classes.hpp.rest + bindings.cpp.rest + sconstruct.rest + test.py.rest -* `bindings.cpp`_ file contains source code that exposes the classes to Python. - -* `sconstruct`_ file contains build instructions for scons build tool. - -* `test.py`_ file contains complete unit tests for the exposed classes - All files contain comments, which describe what and why was done. -.. _`smart_ptr.h` : ./smart_ptr.h.html -.. _`classes.hpp` : ./classes.hpp.html -.. _`bindings.cpp` : ./bindings.cpp.html -.. _`sconstruct` : ./sconstruct.html -.. _`test.py` : ./test.py.html - -------- Download -------- Modified: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/test.py.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/test.py.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/test.py.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,2 +1,6 @@ +==================== +Usage example/Tester +==================== + .. literalinclude:: ./test.py :language: python Deleted: pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/www_configuration.py =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/smart_ptrs/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,3 +0,0 @@ -name = 'custom smart pointer' -files_to_skip = ['definition.rest'] -names = {} Deleted: pyplusplus_dev/docs/troubleshooting_guide/www_configuration.py =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/www_configuration.py 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/troubleshooting_guide/www_configuration.py 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,3 +0,0 @@ -name = 'Boost.Python - troubleshooting guide' -main_html_file = 'lessons_learned.html' -names = { 'lessons_learned' : 'Boost.Python - lessons learned' } Deleted: pyplusplus_dev/docs/tutorials.rest =================================================================== --- pyplusplus_dev/docs/tutorials.rest 2009-02-01 18:29:31 UTC (rev 1646) +++ pyplusplus_dev/docs/tutorials.rest 2009-02-01 20:00:45 UTC (rev 1647) @@ -1,7 +0,0 @@ -.. raw:: html - - <head><meta http-equiv="refresh" content="0; URL=./documentation/tutorials/tutorials.html"/></head> - <body> - Automatic redirection failed, please go to - <a href="./documentation/tutorials/tutorials.html">./documentation/tutorials/tutorials.html</a> - </body> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |