[pygccxml-commit] SF.net SVN: pygccxml:[1674]
Brought to you by:
mbaas,
roman_yakovenko
|
From: <rom...@us...> - 2009-02-12 09:15:11
|
Revision: 1674
http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1674&view=rev
Author: roman_yakovenko
Date: 2009-02-12 09:15:05 +0000 (Thu, 12 Feb 2009)
Log Message:
-----------
sphinx
Modified Paths:
--------------
pygccxml_dev/docs/pygccxml.rest
pyplusplus_dev/docs/documentation/containers.rest
pyplusplus_dev/docs/documentation/index.rest
pyplusplus_dev/docs/pyplusplus.rest
pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py
sphinx/conf.py
Added Paths:
-----------
pyplusplus_dev/docs/documentation/indexing_suite_v2.html.rest
Property Changed:
----------------
sphinx/
Modified: pygccxml_dev/docs/pygccxml.rest
===================================================================
--- pygccxml_dev/docs/pygccxml.rest 2009-02-11 20:51:29 UTC (rev 1673)
+++ pygccxml_dev/docs/pygccxml.rest 2009-02-12 09:15:05 UTC (rev 1674)
@@ -1,6 +1,6 @@
-======================
-pygccxml documentation
-======================
+================
+pygccxml package
+================
.. meta::
:description: C++ declarations parser
Modified: pyplusplus_dev/docs/documentation/containers.rest
===================================================================
--- pyplusplus_dev/docs/documentation/containers.rest 2009-02-11 20:51:29 UTC (rev 1673)
+++ pyplusplus_dev/docs/documentation/containers.rest 2009-02-12 09:15:05 UTC (rev 1674)
@@ -35,7 +35,7 @@
containers. Well, actually he did much more - he implemented new framework.
This framework provides support for almost all C++ containers and also an easy
way to add support for custom ones. You'd better read his `post`_ to
-`Boost.Python`_ mailing list or `documentation`_ for the new indexing suite.
+`Boost.Python`_ mailing list or :doc:`documentation <indexing_suite_v2.html>` for the new indexing suite.
Now, I am sure you have the following question: if this suite is so good, why it is not
@@ -47,7 +47,6 @@
* http://mail.python.org/pipermail/c++-sig/2006-June/010835.html
-.. _`documentation` : ./indexing_suite_v2.html
.. _`post` : http://mail.python.org/pipermail/c++-sig/2003-October/005802.html
@@ -192,5 +191,4 @@
.. _`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-11 20:51:29 UTC (rev 1673)
+++ pyplusplus_dev/docs/documentation/index.rest 2009-02-12 09:15:05 UTC (rev 1674)
@@ -38,9 +38,10 @@
properties.rest
multi_module_development.rest
containers.rest
+ indexing_suite_v2.html.rest
doc_string.rest
warnings.rest
ctypes/ctypes_integration.rest
how_to/how_to.rest
apidocs/api.rest
-
+
Added: pyplusplus_dev/docs/documentation/indexing_suite_v2.html.rest
===================================================================
--- pyplusplus_dev/docs/documentation/indexing_suite_v2.html.rest (rev 0)
+++ pyplusplus_dev/docs/documentation/indexing_suite_v2.html.rest 2009-02-12 09:15:05 UTC (rev 1674)
@@ -0,0 +1,6 @@
+=================
+Indexing Suite V2
+=================
+
+.. raw:: html
+ :file: indexing_suite_v2.html
Modified: pyplusplus_dev/docs/pyplusplus.rest
===================================================================
--- pyplusplus_dev/docs/pyplusplus.rest 2009-02-11 20:51:29 UTC (rev 1673)
+++ pyplusplus_dev/docs/pyplusplus.rest 2009-02-12 09:15:05 UTC (rev 1674)
@@ -1,6 +1,6 @@
-====================
-`Py++` introduction
-====================
+==============
+`Py++` package
+==============
----------------
What is `Py++`?
@@ -19,7 +19,7 @@
Code generation process
-----------------------
-Code generation process, using `Py++` consists from few steps. The following
+Code generation process, using `Py++` consists from few steps. The following
paragraphs will tell you more about every step.
@@ -89,10 +89,10 @@
It means that you don't have to change code generator source code every time.
So far, so good what about second question? Well, by default `Py++` generates a
-code that will satisfy almost all developers. `Py++` could be configured in many
-ways to satisfy your needs. But sometimes this is still not enough. There are
-use cases when you need full control over generated code. One of the biggest
-problems, with code generators in general, is modifying generated code and
+code that will satisfy almost all developers. `Py++` could be configured in many
+ways to satisfy your needs. But sometimes this is still not enough. There are
+use cases when you need full control over generated code. One of the biggest
+problems, with code generators in general, is modifying generated code and
preserving changes. How many code generators did you use or know, that
allow you to put your code anywhere or to reorder generated code as you wish?
`Py++` allows you to do that.
@@ -171,7 +171,7 @@
.. toctree::
:maxdepth: 1
-
+
documentation/tutorials/tutorials.rest
quotes.rest
download.rest
Modified: pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py
===================================================================
--- pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py 2009-02-11 20:51:29 UTC (rev 1673)
+++ pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py 2009-02-12 09:15:05 UTC (rev 1674)
@@ -296,7 +296,7 @@
class memory_managers:
"""implements code generation for `Py++` defined memory managers
- For complete documentation and usage example see :doc:`call policies document <pyplusplus/documentation/functions/call_policies/call_policies>`
+ For complete documentation and usage example see "Call policies" document.
"""
none = 'none'
delete_ = 'delete_'
@@ -312,7 +312,7 @@
class convert_array_to_tuple_t( compound_policy_t ):
"""implements code generation for `Py++` defined "as_tuple" value policy
- For complete documentation and usage example see :doc:`call policies document <pyplusplus/documentation/functions/call_policies/call_policies>`
+ For complete documentation and usage example see "Call policies" document.
"""
def __init__( self, array_size, memory_manager, make_object_call_policies=None, base=None):
compound_policy_t.__init__( self, base )
@@ -369,7 +369,7 @@
class return_range_t( call_policy_t ):
"""implements code generation for `Py++` defined "return_range" call policies
- For complete documentation and usage example see :doc:`call policies document <pyplusplus/documentation/functions/call_policies/call_policies>`
+ For complete documentation and usage example see "Call policies" document.
"""
HEADER_FILE = "__return_range.pypp.hpp"
def __init__( self, get_size_class, value_type, value_policies):
Property changes on: sphinx
___________________________________________________________________
Modified: svn:ignore
- __build
pydsc
pygccxml
pyplusplus
index.rest
+ __build
pydsc
pygccxml
pyplusplus
index.rest
html_documentation
Modified: sphinx/conf.py
===================================================================
--- sphinx/conf.py 2009-02-11 20:51:29 UTC (rev 1673)
+++ sphinx/conf.py 2009-02-12 09:15:05 UTC (rev 1674)
@@ -14,7 +14,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os, shutil
+import sys, os, shutil, atexit
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
@@ -24,7 +24,11 @@
project_root = os.path.abspath('..')
doc_project_root = os.path.abspath('.')
packages = ( 'pydsc', 'pygccxml', 'pyplusplus' )
+html_documentation_dir_name = 'html_documentation'
+if html_documentation_dir_name not in str( sys.argv ):
+ raise RuntimeError( "\n\n\nThe documentation directory name should be: '%s'\n\n\n" % html_documentation_dir_name )
+
has_true_links = 'linux' in sys.platform
for pkg in packages:
target = os.path.join( doc_project_root, pkg )
@@ -59,6 +63,13 @@
except:
pass #it is possible that pyenchant is not installed
+@atexit.register
+def copy_indexing_suite_v2_files():
+ source_dir = os.path.join( project_root, 'pyplusplus_dev', 'docs', 'documentation', 'indexing_suite_v2_files' )
+ target_dir = os.path.join( doc_project_root, html_documentation_dir_name, 'pyplusplus', 'documentation', 'indexing_suite_v2_files' )
+ if os.path.exists(target_dir):
+ shutil.rmtree(target_dir)
+ shutil.copytree( source_dir, target_dir, ignore=shutil.ignore_patterns( r'.svn' ) )
# General configuration
# ---------------------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|