|
From: Roman <rom...@us...> - 2006-04-06 06:16:45
|
Update of /cvsroot/pygccxml/source/pygccxml/docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28954/pygccxml/docs Modified Files: default.css download.rest example.py generate_docs.py pkg-info.txt pygccxml.rest Log Message: There are a lot of changes, sorry CVS did not worked for week or something like this Changes 1. Lots of code clean up 2. Adding and updating documentation 3. Adding new method on decl_wrapper - readme. This method will return list of msgs to the developer. For example if function takes by reference fundamental type it will say that this function could not be called from Python 4. Logging functionlity has been added to file writers too 5. Few bug fixes 6. For operator [] call policies is always set. Index: download.rest =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/download.rest,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** download.rest 24 Jan 2006 05:46:27 -0000 1.1 --- download.rest 6 Apr 2006 06:15:57 -0000 1.2 *************** *** 49,64 **** * `Docutils`_ - only in case you want to create\\extend current documentation - -------------------------------------------------------------------------------- - - Hosted by |SourceForge|__ - - __ http://sourceforge.net/ - .. |SourceForge| image:: http://sourceforge.net/sflogo.php?group_id=118209&type=4 - :alt: SourceForge.net Logo - :align: middle - :width: 125 - :height: 37 - .. :border: 0 - .. _`pygccxml` : ./../pygccxml/pygccxml.html .. _`SourceForge`: http://sourceforge.net/index.php --- 49,52 ---- Index: example.py =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/example.py,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** example.py 2 May 2005 03:31:05 -0000 1.5 --- example.py 6 Apr 2006 06:15:57 -0000 1.6 *************** *** 1,19 **** ! # Copyright 2004 Roman Yakovenko. ! # Distributed under the Boost Software License, Version 1.0. (See ! # accompanying file LICENSE_1_0.txt or copy at ! # http://www.boost.org/LICENSE_1_0.txt) ! ! #This example assumes that you have gccxml in your path. ! ! import os ! import sys ! import pygccxml ! ! config = pygccxml.parser.config_t( gccxml_path=r'c:/tools/gcc_xml' ) ! namespaces = pygccxml.parser.parse( ['core_class_hierarchy.hpp'], config ) ! all_declarations = pygccxml.declarations.make_flatten(namespaces) ! for decl in all_declarations: ! print decl.__class__.__name__, ' : ', decl.name ! if isinstance( decl, pygccxml.declarations.class_t ): ! print '\tbases: ', `[base.related_class.name for base in decl.bases]` ! print '\tderived: ', `[derive.related_class.name for derive in decl.derived]` --- 1,23 ---- ! # Copyright 2004 Roman Yakovenko. ! # Distributed under the Boost Software License, Version 1.0. (See ! # accompanying file LICENSE_1_0.txt or copy at ! # http://www.boost.org/LICENSE_1_0.txt) ! ! from pygccxml import parser ! from pygccxml import declarations ! ! #configure GCC-XML parser ! config = parser.config_t( gccxml_path=r'/home/roman/gccxml/bin/gccxml' ) ! #parsing source file ! global_ns = parser.parse( ['core_class_hierarchy.hpp'], config ) ! #printing all declarations found in file and its includes ! declarations.print_declarations( global_ns ) ! #selecting all classes ! all_decls = declarations.make_flatten( global_ns ) ! all_classes = filter( lambda decl: isinstance( decl, declarations.class_t ) ! , all_decls ) ! #print all base and derived class names ! for class_ in all_classes: ! print class_.name ! print '\tbases: ', `[base.related_class.name for base in class_.bases]` ! print '\tderived: ', `[derive.related_class.name for derive in class_.derived]` Index: generate_docs.py =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/generate_docs.py,v retrieving revision 1.33 retrieving revision 1.34 diff -C2 -d -r1.33 -r1.34 *** generate_docs.py 16 Jan 2006 05:59:45 -0000 1.33 --- generate_docs.py 6 Apr 2006 06:15:57 -0000 1.34 *************** *** 8,11 **** --- 8,30 ---- from docutils.core import publish_file + packages = [ "declarations" + , "parser" + , "utils" + , "__init__.py" ] + + def run_epydoc( source_dir, destination_dir ): + global packages + pygccxml_dir = os.path.join( source_dir, '../../pygccxml' ) + packages = map( lambda package: '"%s"' % os.path.join( pygccxml_dir, package ), packages ) + + options = [ '--output "%s" ' % os.path.join( destination_dir, 'auto_docs' ) + , '--docformat epytext' + , '--url http://www.language-binding.net' + , '--css default.css' + , '--name pygccxml' + , ' '.join( packages ) ] + cmd_line = "epydoc " + ' '.join( options ) + os.system(cmd_line) + def generate( source_dir, destination_dir ): publish_file( source_path=os.path.join( source_dir, 'pygccxml.rest' ) *************** *** 16,19 **** --- 35,39 ---- shutil.copyfile( os.path.join( source_dir, f ) , os.path.join( destination_dir, f ) ) + run_epydoc( source_dir, destination_dir ) if __name__ == '__main__': Index: pkg-info.txt =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/pkg-info.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** pkg-info.txt 29 Dec 2005 06:10:17 -0000 1.1 --- pkg-info.txt 6 Apr 2006 06:15:57 -0000 1.2 *************** *** 1,5 **** Metadata-Version: 1.1 Name: pygccxml ! Version: 0.6.9 Author: Roman Yakovenko Author-email: roman yakovenko at gmail com --- 1,5 ---- Metadata-Version: 1.1 Name: pygccxml ! Version: 0.7.1 Author: Roman Yakovenko Author-email: roman yakovenko at gmail com Index: pygccxml.rest =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/pygccxml.rest,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** pygccxml.rest 13 Mar 2006 09:22:00 -0000 1.5 --- pygccxml.rest 6 Apr 2006 06:15:57 -0000 1.6 *************** *** 12,24 **** , опиÑание, опÑеделение, иеÑаÑÑ Ð¸Ñ ÐºÐ»Ð°ÑÑов, генеÑаÑÐ¾Ñ ÐºÐ¾Ð´Ð° ! -------------- ! Introduction ! -------------- ! .. include:: ./definition.rest ! I'd like to see an example ! -------------------------- First of all let's see a small and simple `example`_. This example prints all declarations found in the `core_class_hierarchy.hpp`_ file. Also, for instances --- 12,39 ---- , опиÑание, опÑеделение, иеÑаÑÑ Ð¸Ñ ÐºÐ»Ð°ÑÑов, генеÑаÑÐ¾Ñ ÐºÐ¾Ð´Ð° ! ------------ ! Introduction ! ------------ .. include:: ./definition.rest ! ---------------------- ! What can I do with it? ! ---------------------- ! Using `pygccxml`_ you can: ! ! * parse C++ source code ! * build a code generator ! ! + `pyplusplus`_ is havily based on `pygccxml`_ ! + generate `WSDL`_ file from sources ! + ... + * create UML diagrams + * build code analizer + * ... + + ------------- + Usage example + ------------- First of all let's see a small and simple `example`_. This example prints all declarations found in the `core_class_hierarchy.hpp`_ file. Also, for instances *************** *** 293,325 **** strategy. ! --------- ! Thanks to ! --------- ! ! * My wife Yulia - she helped me to edit the initial version of this manuals. All ! mistakes and bugs are mine. I'd like to believe that I know `Python`_ better ! then English. ! ! * Brad King for `GCC-XML`_ ! ! * Detlev Offenbach for `Eric 3.6`_ ! ! * `Docutils`_ - easy to use documentation system ! ! * Phil Schwartz - `ReleaseForge`_ - easiest way to release your product on ! `SourceForge`_ ! ! * John Pallister <jo...@sy...> - he helped me to edit\\correct documentation ! ! * Hosted by |SourceForge|__ ! ! __ http://sourceforge.net/ ! .. |SourceForge| image:: http://sourceforge.net/sflogo.php?group_id=118209&type=4 ! :alt: SourceForge.net Logo ! :align: middle ! :width: 125 ! :height: 37 ! .. :border: 0 ! .. _`pygccxml`: ./pygccxml.html .. _`SourceForge`: http://sourceforge.net/index.php --- 308,313 ---- strategy. ! .. _`WSDL`: http://www.w3.org/TR/wsdl ! .. _`pyplusplus`: ./../pyplusplus/pyplusplus.html .. _`pygccxml`: ./pygccxml.html .. _`SourceForge`: http://sourceforge.net/index.php *************** *** 328,332 **** .. _`GCC-XML`: http://www.gccxml.org .. _`Boost Software License`: http://boost.org/more/license_info.html - .. _`Eric 3.6`: http://www.die-offenbachs.de/detlev/eric3.html .. _`Debian Linux`: http://www.debian.org .. _`UML diagram` : ./declarations.png --- 316,319 ---- Index: default.css =================================================================== RCS file: /cvsroot/pygccxml/source/pygccxml/docs/default.css,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** default.css 27 Oct 2005 05:31:57 -0000 1.4 --- default.css 6 Apr 2006 06:15:57 -0000 1.5 *************** *** 1,327 **** ! /* ! :Authors: David Goodger, David Abrahams ! :Contact: go...@us..., da...@bo... ! :date: $Date$ ! :version: $Revision$ ! :copyright: This stylesheet has been placed in the public domain. ! ! This stylesheet is for the use of ReStructuredText in a Boost context. ! It is basically an agglomeration of boost.css and the default.css that ! comes from docutils. ! ! */ ! ! .first { ! margin-top: 0 } ! ! .last { ! margin-bottom: 0 } ! ! a.toc-backref { ! text-decoration: none ; ! color: black } ! ! dd { ! margin-bottom: 0.5em } ! ! div.abstract { ! margin: 2em 5em } ! ! div.abstract p.topic-title { ! font-weight: bold ; ! text-align: center } ! ! div.attention, div.caution, div.danger, div.error, div.hint, ! div.important, div.note, div.tip, div.warning, div.admonition { ! margin: 2em ; ! border: medium outset ; ! padding: 1em } ! ! div.attention p.admonition-title, div.caution p.admonition-title, ! div.danger p.admonition-title, div.error p.admonition-title, ! div.warning p.admonition-title { ! color: red ; ! font-weight: bold ; ! font-family: sans-serif } ! ! div.hint p.admonition-title, div.important p.admonition-title, ! div.note p.admonition-title, div.tip p.admonition-title, ! div.admonition p.admonition-title { ! font-weight: bold ; ! font-family: sans-serif } ! ! div.dedication { ! margin: 2em 5em ; ! text-align: center ; ! font-style: italic } ! ! div.dedication p.topic-title { ! font-weight: bold ; ! font-style: normal } ! ! div.figure { ! margin-left: 2em } ! ! div.footer, div.header { ! font-size: smaller } ! ! div.line-block { display: block } ! div.line-block div.line-block { margin-left: 1.5em } ! ! div.sidebar { ! margin-left: 1em ; ! border: medium outset ; ! padding: 0em 1em ; ! background-color: #ffffee ; ! width: 40% ; ! float: right ; ! clear: right } ! ! div.sidebar p.rubric { ! font-family: sans-serif ; ! font-size: medium } ! ! div.system-messages { ! margin: 5em } ! ! div.system-messages h1 { ! color: red } ! ! div.system-message { ! border: medium outset ; ! padding: 1em } ! ! div.system-message p.system-message-title { ! color: red ; ! font-weight: bold } ! ! div.topic { ! margin: 2em } ! ! dt { ! font-weight: bold ! } ! ! H1.title ! { ! FONT-SIZE: 200%; ! COLOR: #00008B; ! text-align: center ! } ! H1 ! { ! FONT-SIZE: 150%; ! } ! H2 ! { ! FONT-SIZE: 125%; ! } ! h2.subtitle { ! text-align: center } ! H3 ! { ! FONT-SIZE: 108%; ! } ! BODY ! { ! FONT-SIZE: 100%; ! BACKGROUND-COLOR: #ffffff; ! } ! PRE ! { ! MARGIN-LEFT: 2em; ! FONT-FAMILY: Courier; ! } ! CODE ! { ! FONT-FAMILY: Courier; ! white-space: pre; ! } ! .pre ! { ! FONT-FAMILY: Courier; ! white-space: pre; ! } ! .index ! { ! TEXT-ALIGN: left; ! } ! .page-index ! { ! TEXT-ALIGN: left; ! } ! .definition ! { ! TEXT-ALIGN: left; ! } ! .footnote ! { ! FONT-SIZE: 80%; ! VERTICAL-ALIGN: super; ! TEXT-DECORATION: none; ! } ! .function-semantics ! { ! CLEAR: left; } ! hr { ! width: 75% } ! ! ol.simple, ul.simple { ! margin-bottom: 1em } ! ! ol.arabic { ! list-style: decimal } ! ! ol.loweralpha { ! list-style: lower-alpha } ! ! ol.upperalpha { ! list-style: upper-alpha } ! ! ol.lowerroman { ! list-style: lower-roman } ! ! ol.upperroman { ! list-style: upper-roman } ! ! p.attribution { ! text-align: right ; ! margin-left: 50% } ! ! p.caption { ! font-style: italic } ! ! p.credits { ! font-style: italic ; ! font-size: smaller } ! ! p.label { ! white-space: nowrap } ! ! p.rubric { ! font-weight: bold ; ! font-size: larger ; ! color: maroon ; ! text-align: center } ! ! p.sidebar-title { ! font-family: sans-serif ; ! font-weight: bold ; ! font-size: larger } ! ! p.sidebar-subtitle { ! font-family: sans-serif ; ! font-weight: bold } ! ! p.topic-title { ! font-weight: bold } ! ! pre.address { ! margin-bottom: 0 ; ! margin-top: 0 ; ! font-family: serif ; ! font-size: 100% } ! ! pre.line-block { ! font-family: serif ; ! font-size: 100% } ! ! pre.literal-block, pre.doctest-block { ! margin-left: 2em ; ! margin-right: 2em ; ! background-color: #eeeeee } ! span.class { ! font-family: monospace; } ! span.classifier { ! font-family: sans-serif ; ! font-style: oblique } ! ! span.classifier-delimiter { ! font-family: sans-serif ; ! font-weight: bold } ! ! span.doublesize { ! font-size: 200% } ! span.interpreted { ! font-family: sans-serif } ! ! span.concept { ! font-family: sans-serif } ! ! span.function { ! font-family: monospace; } ! span.option { ! white-space: nowrap } ! ! span.option-argument { ! font-style: italic } ! ! span.pre { ! white-space: pre } ! ! span.problematic { ! color: red } ! ! /* Firefox, at least, seems to need some help lowering ! subscripts. Without the following, subscripts seem not to drop ! at all when in a preformatted block. -- DWA ! */ ! ! sub { ! vertical-align: -20% } ! table { ! margin-top: 0.5em ; ! margin-bottom: 0.5em } ! ! table.citation { ! border-left: solid thin gray ; ! padding-left: 0.5ex } ! ! table.docinfo { ! margin: 2em 4em } ! ! table.footnote { ! border-left: solid thin black ; ! padding-left: 0.5ex } ! ! td, th { ! padding-left: 0.5em ; ! padding-right: 0.5em ; ! vertical-align: top } ! ! th.docinfo-name, th.field-name { ! font-weight: bold ; ! text-align: left ; ! white-space: nowrap } ! ! /* ! dwa 2003/7/29 -- commented out so that it wouldn't override earlier ! styles from boost.css ! ! h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { ! font-size: 100% } ! */ ! ! ul.auto-toc { ! list-style-type: none } ! ! img.boost-logo { ! border: none; ! vertical-align: middle } ! pre.literal-block span.concept { ! font-style: italic; ! } --- 1,42 ---- ! h1{ ! font-size: 120%; ! text-align: left; } ! caption { font-weight: bold } ! div.block { ! border: 1px solid #84b0c7; ! text-align: left; ! margin: 5px; ! margin-bottom: 10px; ! padding: 2px; } ! div.block ul { ! margin-top: 10px; ! margin-bottom: 10px; } ! div.title { ! border: 1px solid #84b0c7; ! text-align: center; ! margin: 2px; ! padding: 2px; } ! div.section h2{ ! text-decoration: none; ! font-size: 100%; } ! a.reference { ! color: #1a419d; ! text-align: right; } ! a{ color: #1a419d } + a:visited{ color: #1a419d } + + a:hover{ background-color: #ddddff } |
