[pygccxml-commit] SF.net SVN: pygccxml:[1678] sphinx
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2009-02-15 06:21:43
|
Revision: 1678 http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1678&view=rev Author: roman_yakovenko Date: 2009-02-15 06:21:39 +0000 (Sun, 15 Feb 2009) Log Message: ----------- sphinx Modified Paths: -------------- index.rest pygccxml_dev/pygccxml/declarations/type_traits.py pygccxml_dev/pygccxml/parser/directory_cache.py pygccxml_dev/pygccxml/parser/source_reader.py pyplusplus_dev/pyplusplus/decl_wrappers/python_traits.py sphinx/__templates_www/layout.html sphinx/conf.py Modified: index.rest =================================================================== --- index.rest 2009-02-13 20:39:34 UTC (rev 1677) +++ index.rest 2009-02-15 06:21:39 UTC (rev 1678) @@ -1,6 +1,6 @@ -=========================== -C++ Python language binding -=========================== +============================== +C\\C++ Python language binding +============================== ---------------- pygccxml package Modified: pygccxml_dev/pygccxml/declarations/type_traits.py =================================================================== --- pygccxml_dev/pygccxml/declarations/type_traits.py 2009-02-13 20:39:34 UTC (rev 1677) +++ pygccxml_dev/pygccxml/declarations/type_traits.py 2009-02-15 06:21:39 UTC (rev 1678) @@ -254,9 +254,9 @@ return nake_type.base def remove_declarated( type_ ): - """removes type-declaration class-binder :class:`declarated_t` from the type_ + """removes type-declaration class-binder :class:`declarated_t` from the `type_` - If type_ is not :class:`declarated_t`, it will be returned as is + If `type_` is not :class:`declarated_t`, it will be returned as is """ type_ = remove_alias( type_ ) if isinstance( type_, cpptypes.declarated_t ): @@ -426,7 +426,7 @@ return decls def has_public_binary_operator( type_, operator_symbol ): - """returns True, if type_ has public binary operator, otherwise False""" + """returns True, if `type_` has public binary operator, otherwise False""" not_artificial = lambda decl: not decl.is_artificial type_ = remove_alias( type_ ) type_ = remove_cv( type_ ) Modified: pygccxml_dev/pygccxml/parser/directory_cache.py =================================================================== --- pygccxml_dev/pygccxml/parser/directory_cache.py 2009-02-13 20:39:34 UTC (rev 1677) +++ pygccxml_dev/pygccxml/parser/directory_cache.py 2009-02-15 06:21:39 UTC (rev 1678) @@ -460,7 +460,7 @@ del self.__id_lut[entry.filename] def is_file_modified(self, id_, signature): - """Check if the file referred to by id_ has been modified. + """Check if the file referred to by `id_` has been modified. """ entry = self.__entries.get(id_) if entry==None: @@ -479,7 +479,7 @@ return filesig!=signature def update_id_counter(self): - """Update the id_ counter so that it doesn't grow forever. + """Update the `id_` counter so that it doesn't grow forever. """ if len(self.__entries)==0: self.__next_id = 1 Modified: pygccxml_dev/pygccxml/parser/source_reader.py =================================================================== --- pygccxml_dev/pygccxml/parser/source_reader.py 2009-02-13 20:39:34 UTC (rev 1677) +++ pygccxml_dev/pygccxml/parser/source_reader.py 2009-02-15 06:21:39 UTC (rev 1678) @@ -57,7 +57,7 @@ to two classes: 1. `scanner_t` - this class scans the "XML" file, generated by GCC-XML and - creates `pygccxml`_ declarations and types classes. After the XML file has + creates :mod:`pygccxml` declarations and types classes. After the XML file has been processed declarations and type class instances keeps references to each other using GCC-XML generated id's. Modified: pyplusplus_dev/pyplusplus/decl_wrappers/python_traits.py =================================================================== --- pyplusplus_dev/pyplusplus/decl_wrappers/python_traits.py 2009-02-13 20:39:34 UTC (rev 1677) +++ pyplusplus_dev/pyplusplus/decl_wrappers/python_traits.py 2009-02-15 06:21:39 UTC (rev 1678) @@ -8,7 +8,7 @@ from pygccxml import declarations def is_immutable( type_ ): - """returns True, if type_ represents Python immutable type""" + """returns True, if `type_` represents Python immutable type""" return declarations.is_fundamental( type_ ) \ or declarations.is_enum( type_ ) \ or declarations.is_std_string( type_ ) \ Modified: sphinx/__templates_www/layout.html =================================================================== --- sphinx/__templates_www/layout.html 2009-02-13 20:39:34 UTC (rev 1677) +++ sphinx/__templates_www/layout.html 2009-02-15 06:21:39 UTC (rev 1678) @@ -1,33 +1,37 @@ -{% extends "!layout.html" %} - -{%- block sidebarsearch %} - {%- if pagename != "search" %} - <div id="searchbox" style="display: none"> - <h3>{{ _('Quick search') }}</h3> - <form class="search" action="{{ pathto('search') }}" method="get"> - <input type="text" name="q" size="18" /> - <input type="submit" value="{{ _('Go') }}" /> - <input type="hidden" name="check_keywords" value="yes" /> - <input type="hidden" name="area" value="default" /> - </form> - {% include "left_ad_unit.html" %} - </div> - <script type="text/javascript">$('#searchbox').show(0);</script> - {%- endif %} -{%- endblock %} - -{%- block document %} - <div class="document"> - <div class="documentwrapper"> - {%- if not embedded %} - <div class="bodywrapper"> - {%- endif %} - <div class="body"> - {% block body %} {% endblock %} - {% include "bottom_ad_unit.html" %} - </div> - {%- if not embedded %} - </div> - {%- endif %} - </div> -{%- endblock %} +{% extends "!layout.html" %} + +{%- block rootrellink %} +<li><a href="{{ pathto(master_doc) }}">{{"Language Binding Project"}}</a>{{ reldelim1 }}</li> +{%- endblock %} + +{%- block sidebarsearch %} + {%- if pagename != "search" %} + <div id="searchbox" style="display: none"> + <h3>{{ _('Quick search') }}</h3> + <form class="search" action="{{ pathto('search') }}" method="get"> + <input type="text" name="q" size="18" /> + <input type="submit" value="{{ _('Go') }}" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + {% include "left_ad_unit.html" %} + </div> + <script type="text/javascript">$('#searchbox').show(0);</script> + {%- endif %} +{%- endblock %} + +{%- block document %} + <div class="document"> + <div class="documentwrapper"> + {%- if not embedded %} + <div class="bodywrapper"> + {%- endif %} + <div class="body"> + {% block body %} {% endblock %} + {% include "bottom_ad_unit.html" %} + </div> + {%- if not embedded %} + </div> + {%- endif %} + </div> +{%- endblock %} Modified: sphinx/conf.py =================================================================== --- sphinx/conf.py 2009-02-13 20:39:34 UTC (rev 1677) +++ sphinx/conf.py 2009-02-15 06:21:39 UTC (rev 1678) @@ -14,10 +14,12 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os, shutil, atexit +import sys, os, shutil, atexit, getopt -#Questions -#1. how to read/add/modify command line arguments? +opts, args = getopt.getopt( sys.argv[1:], 'ab:d:c:CD:A:NEqQP') +print 'opts: ', opts +print 'args: ', args +outdir = args[1] # 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 @@ -27,11 +29,7 @@ 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 ) @@ -69,17 +67,19 @@ @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' ) + target_dir = os.path.join( doc_project_root, outdir, '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' ) ) @atexit.register def generate_sitemap(): + if 'www' not in outdir: + return try: import sitemap_gen - working_dir = os.path.join( doc_project_root, html_documentation_dir_name ) + working_dir = os.path.join( doc_project_root, outdir ) config = \ """<?xml version="1.0" encoding="UTF-8"?> <site base_url="http://www.language-binding.net/" store_into="%(path)s/sitemap.xml.gz" verbose="1"> @@ -112,7 +112,9 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['__templates_www'] +templates_path = ['__templates'] +if 'www' in outdir: + templates_path = ['__templates_www'] # The suffix of source filenames. source_suffix = '.rest' @@ -225,7 +227,7 @@ #html_split_index = False # If true, the reST sources are included in the HTML build as _sources/<name>. -html_copy_source = False +html_copy_source = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the @@ -275,7 +277,7 @@ #If true, keep warnings as “system message” paragraphs in the built documents. #Regardless of this setting, warnings are always written to the standard error #stream when sphinx-build is run. -keep_warnings = True +keep_warnings = False # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/dev': None} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |