[Commits] r1224 - in apps/opengeo/geoexplorer/trunk: build src src/doc
commits at geoext.org
commits at geoext.org
Sat Jul 4 09:42:43 CEST 2009
Author: tschaub
Date: 2009-07-04 09:42:43 +0200 (Sat, 04 Jul 2009)
New Revision: 1224
Added:
apps/opengeo/geoexplorer/trunk/src/doc/
apps/opengeo/geoexplorer/trunk/src/doc/Makefile
apps/opengeo/geoexplorer/trunk/src/doc/conf.py
apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst
apps/opengeo/geoexplorer/trunk/src/doc/glossary.rst
apps/opengeo/geoexplorer/trunk/src/doc/index.rst
apps/opengeo/geoexplorer/trunk/src/doc/license.rst
Modified:
apps/opengeo/geoexplorer/trunk/build/build.xml
Log:
Adding doc src and build target.
Modified: apps/opengeo/geoexplorer/trunk/build/build.xml
===================================================================
--- apps/opengeo/geoexplorer/trunk/build/build.xml 2009-07-04 06:43:35 UTC (rev 1223)
+++ apps/opengeo/geoexplorer/trunk/build/build.xml 2009-07-04 07:42:43 UTC (rev 1224)
@@ -14,6 +14,17 @@
<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="dev" depends="clean, init" description="set up development build">
<echo>Setting up development build.</echo>
@@ -59,7 +70,7 @@
</exec>
</target>
- <target name="dist" depends="clean, init, jsbuild" description="prepare app for distribution">
+ <target name="dist" depends="clean, init, jsbuild, doc" description="prepare app for distribution">
<echo>Preparing for distribution.</echo>
<copy todir="${build}/theme/app">
Added: apps/opengeo/geoexplorer/trunk/src/doc/Makefile
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/Makefile (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/Makefile 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,88 @@
+# 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 dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf _build/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
+ @echo
+ @echo "Build finished. The HTML pages are in _build/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in _build/dirhtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(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."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in _build/qthelp, like this:"
+ @echo "# qcollectiongenerator _build/qthelp/GeoExt.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile _build/qthelp/GeoExt.qhc"
+
+latex:
+ $(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:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
+ @echo
+ @echo "The overview file is in _build/changes."
+
+linkcheck:
+ $(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."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in _build/doctest/output.txt."
Added: apps/opengeo/geoexplorer/trunk/src/doc/conf.py
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/conf.py (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/conf.py 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+# GeoExt documentation build configuration file, created by
+# sphinx-quickstart on Wed Apr 15 14:35:45 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 = ['sphinx.ext.todo']
+
+# 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'GeoExplorer'
+copyright = u'2009, OpenGeo'
+
+# 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.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2'
+
+# 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', '_templates']
+
+# 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 = ["_theme"]
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+html_title = 'GeoExplorer v%s' % (version,)
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+html_short_title = 'GeoExplorer'
+
+# 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 = 'favicon.ico'
+
+# 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 = {
+# 'index': 'front_page.html'
+#}
+
+# 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 = False
+
+# 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 = 'GeoExplorerdoc'
+
+html_show_sphinx = False
+
+# -- 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', 'GeoExplorer.tex', u'GeoExplorer 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
Added: apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/getting-started.rst 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,5 @@
+===============
+Getting Started
+===============
+
+This is the getting started doc.
\ No newline at end of file
Added: apps/opengeo/geoexplorer/trunk/src/doc/glossary.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/glossary.rst (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/glossary.rst 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,17 @@
+.. Master glossary for GeoExplorer documentation.
+
+========
+Glossary
+========
+
+.. glossary::
+
+ OGC
+ The `Open Geospatial Consortium <http://www.opengeospatial.org/>`_ (OGC)
+ is a standards organization that develops specifications for geospatial
+ services.
+
+ WMS
+ The `Web Map Service <http://www.opengeospatial.org/standards/wms>`_
+ (WMS) specification from the :term:`OGC` defines an interface for
+ requesting rendered map images across the web.
Added: apps/opengeo/geoexplorer/trunk/src/doc/index.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/index.rst (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/index.rst 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,39 @@
+===========
+GeoExplorer
+===========
+
+Quickly assembly rich mapping applications from multiple :term:`OGC` Web Mapping
+Services (:term:`WMS`) with GeoExplorer. Using the publish wizard, embed your
+mapping application in any web page.
+
+Contents
+--------
+
+.. toctree::
+
+ getting-started
+
+ glossary
+ license
+
+
+Quick Start
+-----------
+
+If you're interested in diving right in, follow the steps below. For more detail
+on getting started with GeoExplorer, see the :doc:`introductory <getting-started>`
+documentation.
+
+#. Open up GeoExplorer in your browser.
+#. Use the add and remove buttons to choose which layers will be included in
+ your application.
+#. From the "Available Layers" dialog, add a new WMS server (e.g.
+ http://terraserver-usa.com/ogccapabilities.ashx).
+#. Reorder layers by dragging
+ them around. Only one layer at a time can be visible in the "Base Layers"
+ group.
+#. Launch the "Publish Map" wizard to embed your application in any web page.
+
+
+
+
Added: apps/opengeo/geoexplorer/trunk/src/doc/license.rst
===================================================================
--- apps/opengeo/geoexplorer/trunk/src/doc/license.rst (rev 0)
+++ apps/opengeo/geoexplorer/trunk/src/doc/license.rst 2009-07-04 07:42:43 UTC (rev 1224)
@@ -0,0 +1,17 @@
+=======
+License
+=======
+
+Documentation
+-------------
+
+This documentation is licensed under the Creative Commons Attribution-Share
+Alike 3.0 United States License. To view a copy of this license, visit
+http://creativecommons.org/licenses/by-sa/3.0/us/ or send a letter to Creative
+Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA.
+
+
+GeoExplorer
+-----------
+
+GeoExplorer is available under the BSD license.
\ No newline at end of file
More information about the Commits
mailing list