sphinx

Author: roman_yakovenko

docs/apidocs/binary_parsers.rest

@@ -2,14 +2,19 @@
 pygccxml.binary_parsers API
 ===========================
 
-binary_parsers package
-----------------------
+--------
+Overview
+--------
 
 .. automodule:: pygccxml.binary_parsers
     :members:
     :show-inheritance:
 
-parsers module
+--------
+Modules
+--------
+
+parsers
 --------------
 
 .. automodule:: pygccxml.binary_parsers.parsers

docs/apidocs/declarations.rest

@@ -2,183 +2,187 @@
 pygccxml.declarations package
 =============================
 
-declarations package
---------------------
+--------
+Overview
+--------
 
 .. automodule:: pygccxml.declarations
     :members:
     :show-inheritance:
 
+--------
+Modules
+--------
 
-algorithm module
+algorithm
 ----------------
 
 .. automodule:: pygccxml.declarations.algorithm
     :members:
     :show-inheritance:
 
-algorithms_cache module
+algorithms_cache
 -------------------------
 
 .. automodule:: pygccxml.declarations.algorithms_cache
     :members:
     :show-inheritance:
 
-calldef module
+calldef
 ----------------
 
 .. automodule:: pygccxml.declarations.calldef
     :members:
     :show-inheritance:
 
-call_invocation module
+call_invocation
 ------------------------
 
 .. automodule:: pygccxml.declarations.call_invocation
     :members:
     :show-inheritance:
 
-class_declaration module
+class_declaration
 --------------------------
 
 .. automodule:: pygccxml.declarations.class_declaration
     :members:
     :show-inheritance:
 
-compilers module
+compilers
 ------------------
 
 .. automodule:: pygccxml.declarations.compilers
     :members:
     :show-inheritance:
 
-container_traits module
+container_traits
 -------------------------
 
 .. automodule:: pygccxml.declarations.container_traits
     :members:
     :show-inheritance:
 
-cpptypes module
+cpptypes
 -----------------
 
 .. automodule:: pygccxml.declarations.cpptypes
     :members:
     :show-inheritance:
 
-declaration module
+declaration
 --------------------
 
 .. automodule:: pygccxml.declarations.declaration
     :members:
     :show-inheritance:
 
-decl_factory module
+decl_factory
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_factory
     :members:
     :show-inheritance:
 
-decl_printer module
+decl_printer
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_printer
     :members:
     :show-inheritance:
 
-decl_visitor module
+decl_visitor
 ---------------------
 
 .. automodule:: pygccxml.declarations.decl_visitor
     :members:
     :show-inheritance:
 
-dependencies module
+dependencies
 ---------------------
 
 .. automodule:: pygccxml.declarations.dependencies
     :members:
     :show-inheritance:
 
-enumeration module
+enumeration
 --------------------
 
 .. automodule:: pygccxml.declarations.enumeration
     :members:
     :show-inheritance:
 
-function_traits module
+function_traits
 ------------------------
 
 .. automodule:: pygccxml.declarations.function_traits
     :members:
     :show-inheritance:
 
-matcher module
+matcher
 ----------------
 
 .. automodule:: pygccxml.declarations.matcher
     :members:
     :show-inheritance:
 
-matchers module
+matchers
 -----------------
 
 .. automodule:: pygccxml.declarations.matchers
     :members:
     :show-inheritance:
 
-mdecl_wrapper module
+mdecl_wrapper
 ----------------------
 
 .. automodule:: pygccxml.declarations.mdecl_wrapper
     :members:
     :show-inheritance:
 
-namespace module
+namespace
 ------------------
 
 .. automodule:: pygccxml.declarations.namespace
     :members:
     :show-inheritance:
 
-scopedef module
+scopedef
 -----------------
 
 .. automodule:: pygccxml.declarations.scopedef
     :members:
     :show-inheritance:
 
-templates module
+templates
 ------------------
 
 .. automodule:: pygccxml.declarations.templates
     :members:
     :show-inheritance:
 
-typedef module
+typedef
 ----------------
 
 .. automodule:: pygccxml.declarations.typedef
     :members:
     :show-inheritance:
 
-type_traits module
+type_traits
 --------------------
 
 .. automodule:: pygccxml.declarations.type_traits
     :members:
     :show-inheritance:
 
-type_visitor module
+type_visitor
 ---------------------
 
 .. automodule:: pygccxml.declarations.type_visitor
     :members:
     :show-inheritance:
 
-variable module
+variable
 ---------------
 
 .. automodule:: pygccxml.declarations.variable

docs/apidocs/parser.rest

@@ -2,50 +2,55 @@
 pygccxml.parser package
 =======================
 
-parser package
---------------
+--------
+Overview
+--------
 
 .. automodule:: pygccxml.parser
     :members:
     :show-inheritance:
 
-config module
+--------
+Modules
+--------
+
+config
 ---------------
 
 .. automodule:: pygccxml.parser.config
     :members:
     :show-inheritance:
 
-declarations_cache module
+declarations_cache
 ----------------------------
 
 .. automodule:: pygccxml.parser.declarations_cache
     :members:
     :show-inheritance:
 
-directory_cache module
+directory_cache
 ------------------------
 
 .. automodule:: pygccxml.parser.directory_cache
     :members:
     :show-inheritance:
 
-patcher module
+patcher
 ----------------
 
 .. automodule:: pygccxml.parser.patcher
     :members:
     :show-inheritance:
 
-project_reader module
+project_reader
 ---------------------
 
 .. automodule:: pygccxml.parser.project_reader
     :members:
     :show-inheritance:
 
 
-source_reader module
+source_reader
 ----------------------
 
 .. automodule:: pygccxml.parser.source_reader

docs/apidocs/utils.rest

@@ -2,15 +2,19 @@
 pygccxml.utils package
 ======================
 
-utils package
--------------
+--------
+Overview
+--------
 
 .. automodule:: pygccxml.utils
     :members:
     :show-inheritance:
 
+--------
+Modules
+--------
 
-fs_utils module
+fs_utils
 ---------------
 
 .. automodule:: pygccxml.utils.fs_utils

docs/pygccxml.rest

@@ -114,7 +114,7 @@ All in all, `pygccxml` has more than 230 tests.
 Support for Python 2.4 was dropped.
 
 -------------------------------
-pygccxml documentation contents
+Documentation contents
 -------------------------------
 
 .. toctree::

pygccxml/utils/__init__.py

@@ -3,9 +3,7 @@
 # accompanying file LICENSE_1_0.txt or copy at
 # http://www.boost.org/LICENSE_1_0.txt)
 
-"""
-defines logger classes and few convenience methods, not related to the declarations tree
-"""
+"""defines logger classes and few convenience methods, not related to the declarations tree"""
 
 import os
 import sys
@@ -37,9 +35,9 @@ class loggers:
     gccxml = cxx_parser #backward compatability
 
     pdb_reader = _create_logger_( 'pygccxml.pdb_reader' )
-    """logger for MS .pdb file reader functionality
     """
-
+    logger for MS .pdb file reader functionality
+    """
 
     queries_engine = _create_logger_( 'pygccxml.queries_engine' )
     """logger for query engine functionality.
@@ -136,13 +134,18 @@ def reset(self):
                 delattr(self, name)
 
 class enum( object ):
-    """Usage example:
-        class fruits(enum):
-            apple = 0
-            orange = 1
+    """
+    Usage example:
+    
+    .. code-block:: python
+
+       class fruits(enum):
+           apple = 0
+           orange = 1
+
+       fruits.has_value( 1 )
+       fruits.name_of( 1 )
 
-        fruits.has_value( 1 )
-        fruits.name_of( 1 )
     """
 
     @classmethod
@@ -163,7 +166,7 @@ def name_of( cls, enum_numeric_value ):
                                 % ( enum_numeric_value, cls.__name__ ) )
 
 class native_compiler:
-    """provides information about "native compiler", which was used to build this Python executable"""
+    """provides information about the compiler, which was used to build the Python executable"""
 
     @staticmethod
     def get_version():

pygccxml/utils/fs_utils.py

@@ -3,6 +3,8 @@
 # accompanying file LICENSE_1_0.txt or copy at
 # http://www.boost.org/LICENSE_1_0.txt)
 
+"""defines few classes, that simplifies a file system entries iteration"""
+
 import os
 from types import *