[pygccxml-commit] SF.net SVN: pygccxml:[1629] sphinx
Brought to you by:
mbaas,
roman_yakovenko
Menu
▾
▴
[pygccxml-commit] SF.net SVN: pygccxml:[1629] sphinx
|
From: <rom...@us...> - 2009-01-28 12:34:39
|
Revision: 1629
http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1629&view=rev
Author: roman_yakovenko
Date: 2009-01-28 11:42:27 +0000 (Wed, 28 Jan 2009)
Log Message:
-----------
adding directory skeleton for sphinx
Added Paths:
-----------
sphinx/
sphinx/Makefile
sphinx/__static/
sphinx/__templates/
sphinx/conf.py
sphinx/index.rest
Property changes on: sphinx
___________________________________________________________________
Added: svn:ignore
+ __build
pydsc
pygccxml
pyplusplus
Added: sphinx/Makefile
===================================================================
--- sphinx/Makefile (rev 0)
+++ sphinx/Makefile 2009-01-28 11:42:27 UTC (rev 1629)
@@ -0,0 +1,75 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d __build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html web pickle htmlhelp latex changes linkcheck
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview over all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+
+clean:
+ -rm -rf __build/*
+
+html:
+ mkdir -p __build/html __build/doctrees
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) __build/html
+ @echo
+ @echo "Build finished. The HTML pages are in __build/html."
+
+pickle:
+ mkdir -p __build/pickle __build/doctrees
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) __build/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+web: pickle
+
+json:
+ mkdir -p __build/json __build/doctrees
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) __build/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ mkdir -p __build/htmlhelp __build/doctrees
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) __build/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in __build/htmlhelp."
+
+latex:
+ mkdir -p __build/latex __build/doctrees
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) __build/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in __build/latex."
+ @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+ "run these through (pdf)latex."
+
+changes:
+ mkdir -p __build/changes __build/doctrees
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) __build/changes
+ @echo
+ @echo "The overview file is in __build/changes."
+
+linkcheck:
+ mkdir -p __build/linkcheck __build/doctrees
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) __build/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in __build/linkcheck/output.txt."
Added: sphinx/conf.py
===================================================================
--- sphinx/conf.py (rev 0)
+++ sphinx/conf.py 2009-01-28 11:42:27 UTC (rev 1629)
@@ -0,0 +1,205 @@
+# -*- coding: utf-8 -*-
+#
+# Language Binding documentation build configuration file, created by
+# sphinx-quickstart on Wed Jan 28 10:41:40 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# The contents of this file are pickled, so don't put values in the namespace
+# that aren't pickleable (module imports are okay, they're removed automatically).
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os, shutil
+
+# 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
+# absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+project_root = os.path.abspath('..')
+doc_project_root = os.path.abspath('.')
+
+for entry in ( 'pydsc', 'pygccxml', 'pyplusplus' ):
+ target = os.path.join( doc_project_root, entry )
+ source = os.path.join( project_root, entry + '_dev', 'docs' )
+ if os.path.exists( target ):
+ shutil.rmtree( target )
+ shutil.copytree( source, target, ignore=shutil.ignore_patterns( r'.svn', '*.pyc', 'apidocs', 'www_configuration.py' ) )
+shutil.copy( os.path.join( project_root, 'index.rest' ), doc_project_root )
+
+# General configuration
+# ---------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['__templates']
+
+# The suffix of source filenames.
+source_suffix = '.rest'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Language Binding'
+copyright = u'2009, Roman Yakovenko'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.1'
+# The full version, including alpha/beta/rc tags.
+release = '1.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['__build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# Options for HTML output
+# -----------------------
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'default.css'
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['__static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, the reST sources are included in the HTML build as _sources/<name>.
+#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
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'LanguageBindingdoc'
+
+
+# Options for LaTeX output
+# ------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, document class [howto/manual]).
+latex_documents = [
+ ('index', 'LanguageBinding.tex', ur'Language Binding Documentation',
+ ur'Roman Yakovenko', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/dev': None}
Added: sphinx/index.rest
===================================================================
--- sphinx/index.rest (rev 0)
+++ sphinx/index.rest 2009-01-28 11:42:27 UTC (rev 1629)
@@ -0,0 +1,96 @@
+===========================
+C++ Python language binding
+===========================
+
+.. contents:: Table of contents
+
+.. toctree::
+ :maxdepth: 2
+
+----------------
+pygccxml package
+----------------
+
+* Do you need to parse C++ code?
+* Do you need to build code generator?
+* Do you need to create UML diagram?
+
+`pygccxml`_ is the way to go! `Learn more`__.
+
+.. __: `pygccxml`_
+
+------------
+Py++ package
+------------
+
+"I love deadlines. I love the whooshing noise they make as they go by."
+ -- Douglas Adams
+
+Meet your deadlines with powerful code generator engine - `Py++`_.
+`Py++`_ package and `Boost.Python`_ library provide a complete solution for
+interfacing Python and C++. `Learn more`_.
+
+*European Space Agency*, *Ogre*, *PyOpenSG* and many others `use`__ Py++.
+
+.. _`Learn more` : `Py++`_
+
+.. __: ./pyplusplus/quotes.html
+
+---------------
+pyboost package
+---------------
+
+`Boost`_ provides free peer-reviewed portable C++ source libraries. `pyboost`_
+package export the following libraries to Python:
+
+ * `Boost.Date_Time`_ - date time library designed to provide a basis for
+ performing efficient time calculations
+ * `Boost.CRC`_ - cyclic redundancy code computation objects
+ * `Boost.Rational`_ - rational number class
+ * `Boost.Random`_ - a complete system for random number generation
+
+Python bindings for `boost.graph`_ library is also available from
+http://www.osl.iu.edu/~dgregor/bgl-python .
+
+-------------
+pydsc package
+-------------
+
+Documentation strings contain spelling errors? `Fix them in a minute`_.
+
+.. _`Fix them in a minute` : `pydsc`_
+
+-----------------
+pyeasybmp package
+-----------------
+
+`EasyBMP`_ could be easier? Yes of course! Learn more about `EasyBMP Python bindings`_.
+
+.. _`EasyBMP Python bindings`: ./pyplusplus/examples/easybmp/easybmp.html
+
+
+.. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+.. _`pyboost` : ./pyplusplus/examples/boost/boost.html
+.. _`boost.graph` : http://www.boost.org/libs/graph/doc/table_of_contents.html
+.. _`boost.date_time` : http://boost.org/doc/html/date_time.html
+.. _`boost.crc` : http://boost.org/libs/crc/index.html
+.. _`boost.rational` : http://boost.org/libs/rational/index.html
+.. _`boost.random` : http://boost.org/libs/random/index.html
+
+.. _`Boost`: http://boost.org/
+.. _`Python`: http://www.python.org
+.. _`pygccxml`: ./pygccxml/pygccxml.html
+.. _`Py++`: ./pyplusplus/pyplusplus.html
+.. _`pydsc`: ./pydsc/pydsc.html
+.. _`EasyBMP`: http://easybmp.sourceforge.net/
+
+.. _`many others` : ./x.html
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
