Permalink
Browse files

Build docs for dist target.

  • Loading branch information...
1 parent 2aa2d11 commit 4d936eb7a7eae72c934523713887c0ca57ca375a @tschaub tschaub committed Jul 21, 2009
Showing with 356 additions and 0 deletions.
  1. +43 −0 build/build.xml
  2. +4 −0 build/jst.cfg
  3. +194 −0 src/doc/conf.py
  4. +115 −0 src/doc/lib/template.jst
View
43 build/build.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="gxp" default="dist" basedir=".">
+
+ <description>
+ GXP Build File
+ </description>
+
+ <property name="src" location="../src"/>
+ <property name="build" location="gxp"/>
+
+ <target name="init">
+ <tstamp/>
+ <mkdir dir="${build}"/>
+ </target>
+
+ <target name="doc" depends="init" description="build documentation">
+ <echo>Building docs.</echo>
+ <exec executable="sphinx-build" failonerror="true">
+ <arg line="-b html"/>
+ <arg value="-d"/>
+ <arg path="${src}/doc/_build/doctrees"/>
+ <arg path="${src}/doc"/>
+ <arg path="${build}/doc"/>
+ </exec>
+ </target>
+
+ <target name="dist" depends="clean, init, doc" description="prepare lib for distribution">
+ <echo>Preparing for distribution.</echo>
+ </target>
+
+ <target name="zip" depends="dist" description="create zip archive of app">
+ <echo>Preparing zip archive.</echo>
+ <zip destfile="${ant.project.name}.zip">
+ <zipfileset dir="${build}" prefix="${ant.project.name}"/>
+ </zip>
+ </target>
+
+ <target name="clean" description="remove previous build">
+ <delete dir="${build}"/>
+ </target>
+
+</project>
+
View
4 build/jst.cfg
@@ -0,0 +1,4 @@
+[gxp]
+root = ../src/script
+template = ../src/doc/lib/template.jst
+output = ../src/doc/lib
View
194 src/doc/conf.py
@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# GXP documentation build configuration file, created by
+# sphinx-quickstart on Mon Jul 20 20:19:58 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# 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
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path 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('.'))
+
+# -- 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'GXP'
+copyright = u'2009, The Open Planning Project'
+
+# 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 = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# 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, links to the reST sources are added to the pages.
+#html_show_sourcelink = 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 = 'GXPdoc'
+
+
+# -- 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, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'GXP.tex', u'GXP Documentation',
+ u'OpenGeo', '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
View
115 src/doc/lib/template.jst
@@ -0,0 +1,115 @@
+{#
+
+ This template is of general use for documenting GXP classes. It produces
+ a doc with the following sections:
+
+ * Header (full class name)
+ * Base Link and Ineritance (optional link to ext super and parent classes)
+ * Xtype (optional)
+ * Constructor (class def)
+ * Examples (optional)
+ * Config Options (optional)
+ * Public Properties (optional)
+ * Public Methods (optional)
+ * Events (optional)
+ * Class Methods (optional)
+
+#}
+.. currentmodule:: {{ module }}
+
+:class:`{{ module }}.{{ class }}`
+================================================================================
+
+{% if base_link is defined or xtype is defined or _parents is defined%}
+.. cssclass:: meta
+
+{% if base_link is defined or _parents is defined %}
+Extends
+ {% if base_link %}* {{ base_link }}{% endif %}
+ {% if _parents %}{% for parent in _parents %}* :class:`{{ parent.module }}.{{ parent.class }}`{% endfor %}{% endif %}
+{% endif %}
+
+{% if xtype is defined %}
+xtype
+ ``{{ xtype }}``
+{% endif %}
+{% endif %}
+
+{{ constructor }}
+
+{% if example is defined %}
+Example Use
+-----------
+
+{{ example }}
+{% endif %}
+
+{% if config is defined %}
+Config Options
+--------------
+
+Configuration properties{% if base_link is defined %} in addition to
+those listed for {{ base_link }}{% endif %}.
+
+{% for (name, desc) in config|dictsort %}
+.. describe:: {{ name }}
+
+ {{ desc|indent(4) }}
+{% endfor %}
+{% endif %}
+
+{% if property is defined %}
+Public Properties
+-----------------
+
+Public properties{% if base_link is defined %} in addition to those
+listed for {{ base_link }}{% endif %}.
+
+{% for (name, desc) in property|dictsort %}
+.. attribute:: {{ class }}.{{ name }}
+
+ {{ desc|indent(4) }}
+{% endfor %}
+{% endif %}
+
+{% if method is defined %}
+Public Methods
+--------------
+
+Public methods{% if base_link is defined %} in addition to those
+listed for {{ base_link }}{% endif %}.
+
+{% for (name, desc) in method|dictsort %}
+.. method:: {{ class }}.{{ name }}
+
+ {{ desc|indent(4) }}
+{% endfor %}
+{% endif %}
+
+{% if event is defined %}
+Events
+------
+
+Events{% if base_link is defined %} in addition to those
+listed for {{ base_link }}{% endif %}.
+
+{% for (name, desc) in event|dictsort %}
+.. describe:: {{ name }}
+
+ {{ desc|indent(4) }}
+{% endfor %}
+{% endif %}
+
+{% if classmethod is defined %}
+Class Methods
+-------------
+
+Class methods{% if base_link is defined %} in addition to static methods
+listed for {{ base_link }}{% endif %}.
+
+{% for (name, desc) in classmethod|dictsort %}
+.. classmethod:: {{ class }}.{{ name }}
+
+ {{ desc|indent(4) }}
+{% endfor %}
+{% endif %}

0 comments on commit 4d936eb

Please sign in to comment.