Initial crack at documentation making use of the Read the Docs Sphinx theme.

.gitignore

@@ -35,3 +35,6 @@ nosetests.xml
 .mr.developer.cfg
 .project
 .pydevproject
+
+# Sphinx
+_build/

docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 "  singlehtml to make a single large HTML file"
+	@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 "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FastKML.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FastKML.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/FastKML"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FastKML"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# FastKML documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct 13 22:24:07 2014.
+#
+# 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
+import 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.insert(0, os.path.abspath('..'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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']
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'FastKML'
+copyright = u'2014, Christian Ledermann & Ian Lee'
+
+# 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.8'
+# The full version, including alpha/beta/rc tags.
+release = '0.8'
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+try:
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+except ImportError:
+    pass
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FastKMLdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'FastKML.tex', u'FastKML Documentation',
+   u'Christian Ledermann \\& Ian Lee', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'fastkml', u'FastKML Documentation',
+     [u'Christian Ledermann & Ian Lee'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'FastKML', u'FastKML Documentation',
+   u'Christian Ledermann & Ian Lee', 'FastKML', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

docs/index.rst

+Welcome to FastKML's documentation!
+===================================
+
+fastkml is a library to read, write and manipulate kml files. It aims to keep
+it simple and fast (using lxml_ if available). "Fast" refers to the time you
+spend to write and read KML files as well as the time you spend to get
+aquainted to the library or to create KML objects. It provides a subset of KML
+and is aimed at documents that can be read from multiple clients such as
+openlayers and google maps rather than to give you all functionality that KML
+on google earth provides.
+
+For more details about the KML Specification, check out the `KML Reference
+<https://developers.google.com/kml/documentation/kmlreference>`_ on the Google
+developers site.
+
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+   installing
+   usage_guide
+   reference_guide
+
+.. _lxml: https://pypi.python.org/pypi/lxml
+.. _kml_reference: https://developers.google.com/kml/documentation/kmlreference

docs/installing.rst

+Installation
+============
+
+Python & OS Support
+-------------------
+
+fastkml works with CPython version 2.6, 2.7, 3.2, 3.3, 3.4
+
+fastkml works on Unix/Linux, OS X, and Windows

docs/quickstart.rst

+Quickstart
+==========
+
+::
+
+    $ pip install fastkml
+
+    # Start working with the library
+    $ python
+    >>> from fastkml import kml
+    >>> k = kml.KML()

docs/reference_guide.rst

+===============
+Reference Guide
+===============
+
+Modules
+=======
+
+atom
+----
+
+.. automodule:: fastkml.atom
+
+base
+----
+
+.. automodule:: fastkml.base
+
+config
+------
+
+.. automodule:: fastkml.config
+
+geometry
+--------
+
+.. automodule:: fastkml.geometry
+
+gx
+--
+
+.. automodule:: fastkml.gx
+
+kml
+---
+
+.. automodule:: fastkml.kml
+
+styles
+------
+
+.. automodule:: fastkml.styles

docs/usage_guide.rst

+Usage Guide
+===========
+
+.. _collective.geo.fastkml: http://pypi.python.org/pypi/collective.geo.fastkml
+
+You can find more examples in the included tests.py file or in
+collective.geo.fastkml_, here is a quick overview:
+
+
+Build a KML from Scratch
+------------------------
+
+Example how to build a simple KML file from the Python interpreter.
+
+.. code-block:: python
+
+    # Import the library
+    >>> from fastkml import kml
+    >>> from shapely.geometry import Point, LineString, Polygon
+
+    # Create the root KML object
+    >>> k = kml.KML()
+    >>> ns = '{http://www.opengis.net/kml/2.2}'
+
+    # Create a KML Document and add it to the KML root object
+    >>> d = kml.Document(ns, 'docid', 'doc name', 'doc description')
+    >>> k.append(d)
+
+    # Create a KML Folder and add it to the Document
+    >>> f = kml.Folder(ns, 'fid', 'f name', 'f description')
+    >>> d.append(f)
+
+    # Create a KML Folder and nest it in the first Folder
+    >>> nf = kml.Folder(ns, 'nested-fid', 'nested f name', 'nested f description')
+    >>> f.append(nf)
+
+    # Create a second KML Folder within the Document
+    >>> f2 = kml.Folder(ns, 'id2', 'name2', 'description2')
+    >>> d.append(f2)
+
+    # Create a Placemark with a simple polygon geometry and add it to the
+    # second folder of the Document
+    >>> p = kml.Placemark(ns, 'id', 'name', 'description')
+    >>> p.geometry =  Polygon([(0, 0, 0), (1, 1, 0), (1, 0, 1)])
+    >>> f2.append(p)
+
+    # Print out the KML Object as a string
+    >>> print k.to_string(prettyprint=True)
+    '<kml:kml xmlns:ns0="http://www.opengis.net/kml/2.2">
+      <kml:Document id="docid">
+        <kml:name>doc name</kml:name>
+        <kml:description>doc description</kml:description>
+        <kml:visibility>1</kml:visibility>
+        <kml:open>0</kml:open>
+        <kml:Folder id="fid">
+          <kml:name>f name</kml:name>
+          <kml:description>f description</kml:description>
+          <kml:visibility>1</kml:visibility>
+          <kml:open>0</kml:open>
+          <kml:Folder id="nested-fid">
+            <kml:name>nested f name</kml:name>
+            <kml:description>nested f description</kml:description>
+            <kml:visibility>1</kml:visibility>
+            <kml:open>0</kml:open>
+          </kml:Folder>
+        </kml:Folder>
+        <kml:Folder id="id2">
+          <kml:name>name2</kml:name>
+          <kml:description>description2</kml:description>
+          <kml:visibility>1</kml:visibility>
+          <kml:open>0</kml:open>
+          <kml:Placemark id="id">
+            <kml:name>name</kml:name>
+            <kml:description>description</kml:description>
+            <kml:visibility>1</kml:visibility>
+            <kml:open>0</kml:open>
+            <kml:Polygon>
+              <kml:outerBoundaryIs>
+                <kml:LinearRing>
+                  <kml:coordinates>
+                    0.000000,0.000000,0.000000
+                    1.000000,1.000000,0.000000
+                    1.000000,0.000000,1.000000
+                    0.000000,0.000000,0.000000
+                  </kml:coordinates>
+                </kml:LinearRing>
+             </kml:outerBoundaryIs>
+            </kml:Polygon>
+          </kml:Placemark>
+        </kml:Folder>
+      </kml:Document>
+    </kml:kml>'
+
+
+
+Read a KML File
+---------------
+
+You can create a KML object by reading a KML file as a string
+
+.. code-block:: python
+
+    # Start by importing the kml module
+    >>> from fastkml import kml
+
+    # Setup the string which contains the KML file we want to read
+    >>> doc = """<?xml version="1.0" encoding="UTF-8"?>
+    ... <kml xmlns="http://www.opengis.net/kml/2.2">
+    ... <Document>
+    ...   <name>Document.kml</name>
+    ...   <open>1</open>
+    ...   <Style id="exampleStyleDocument">
+    ...     <LabelStyle>
+    ...       <color>ff0000cc</color>
+    ...     </LabelStyle>
+    ...   </Style>
+    ...   <Placemark>
+    ...     <name>Document Feature 1</name>
+    ...     <styleUrl>#exampleStyleDocument</styleUrl>
+    ...     <Point>
+    ...       <coordinates>-122.371,37.816,0</coordinates>
+    ...     </Point>
+    ...   </Placemark>
+    ...   <Placemark>
+    ...     <name>Document Feature 2</name>
+    ...     <styleUrl>#exampleStyleDocument</styleUrl>
+    ...     <Point>
+    ...       <coordinates>-122.370,37.817,0</coordinates>
+    ...     </Point>
+    ...   </Placemark>
+    ... </Document>
+    ... </kml>"""
+
+    # Create the KML object to store the parsed result
+    >>> k = kml.KML()
+
+    # Read in the KML string
+    >>> k.from_string(doc)
+
+    # Next we perform some simple sanity checks
+
+    # Check that the number of features is correct
+    # This corresponds to the single ``Document``
+    >>> features = list(k.features())
+    >>> len(features)
+    1
+
+    # Check that we can access the features as a generator
+    # (The two Placemarks of the Document)
+    >>> features[0].features()
+    <generator object features at 0x2d7d870>
+    >>> f2 = list(features[0].features())
+    >>> len(f2)
+    2
+
+    # Check specifics of the first Placemark in the Document
+    >>> f2[0]
+    <fastkml.kml.Placemark object at 0x2d791d0>
+    >>> f2[0].description
+    >>> f2[0].name
+    'Document Feature 1'
+
+    # Check specifics of the second Placemark in the Document
+    >>> f2[1].name
+    'Document Feature 2'
+    >>> f2[1].name = "ANOTHER NAME"
+
+    # Verify that we can print back out the KML object as a string
+    >>> print k.to_string(prettyprint=True)
+    <kml:kml xmlns:ns0="http://www.opengis.net/kml/2.2">
+      <kml:Document>
+        <kml:name>Document.kml</kml:name>
+        <kml:visibility>1</kml:visibility>
+        <kml:open>1</kml:open>
+        <kml:Style id="exampleStyleDocument">
+          <kml:LabelStyle>
+            <kml:color>ff0000cc</kml:color>
+            <kml:scale>1.0</kml:scale>
+          </kml:LabelStyle>
+        </kml:Style>
+        <kml:Placemark>
+          <kml:name>Document Feature 1</kml:name>
+          <kml:visibility>1</kml:visibility>
+          <kml:open>0</kml:open>
+          <kml:Point>
+            <kml:coordinates>-122.371000,37.816000,0.000000</kml:coordinates>
+          </kml:Point>
+        </kml:Placemark>
+        <kml:Placemark>
+          <kml:name>ANOTHER NAME</kml:name>
+          <kml:visibility>1</kml:visibility>
+          <kml:open>0</kml:open>
+          <kml:Point>
+            <kml:coordinates>-122.370000,37.817000,0.000000</kml:coordinates>
+          </kml:Point>
+        </kml:Placemark>
+      </kml:Document>
+    </kml:kml>
+
+

fastkml/gx.py

@@ -20,13 +20,14 @@ With the launch of Google Earth 5.0, Google has provided extensions to KML
 to support a number of new features. These extensions use the gx prefix
 and the following namespace URI:
 
- xmlns:gx="http://www.google.com/kml/ext/2.2"
+    xmlns:gx="http://www.google.com/kml/ext/2.2"
 
 This namespace URI must be added to the <kml> element in any KML file
 using gx-prefixed elements:
 
-<kml xmlns="http://www.opengis.net/kml/2.2"
- xmlns:gx="http://www.google.com/kml/ext/2.2">
+    <kml xmlns="http://www.opengis.net/kml/2.2"
+    xmlns:gx="http://www.google.com/kml/ext/2.2">
+
 Extensions to KML may not be supported in all geo-browsers. If your
 browser doesn't support particular extensions, the data in those
 extensions should be silently ignored, and the rest of the KML file
@@ -34,41 +35,42 @@ should load without errors.
 
 Elements that currently use the gx prefix are:
 
-gx:altitudeMode
-gx:altitudeOffset
-gx:angles
-gx:AnimatedUpdate
-gx:balloonVisibility
-gx:coord
-gx:delayedStart
-gx:drawOrder
-gx:duration
-gx:FlyTo
-gx:flyToMode
-gx:h
-gx:horizFov
-gx:interpolate
-gx:labelVisibility
-gx:LatLonQuad
-gx:MultiTrack
-gx:vieweroptions
-gx:outerColor
-gx:outerWidth
-gx:physicalWidth
-gx:Playlist
-gx:playMode
-gx:SoundCue
-gx:TimeSpan
-gx:TimeStamp
-gx:Tour
-gx:TourControl
-gx:TourPrimitive
-gx:Track
-gx:ViewerOptions
-gx:w
-gx:Wait
-gx:x
-gx:y
+* gx:altitudeMode
+* gx:altitudeOffset
+* gx:angles
+* gx:AnimatedUpdate
+* gx:balloonVisibility
+* gx:coord
+* gx:delayedStart
+* gx:drawOrder
+* gx:duration
+* gx:FlyTo
+* gx:flyToMode
+* gx:h
+* gx:horizFov
+* gx:interpolate
+* gx:labelVisibility
+* gx:LatLonQuad
+* gx:MultiTrack
+* gx:vieweroptions
+* gx:outerColor
+* gx:outerWidth
+* gx:physicalWidth
+* gx:Playlist
+* gx:playMode
+* gx:SoundCue
+* gx:TimeSpan
+* gx:TimeStamp
+* gx:Tour
+* gx:TourControl
+* gx:TourPrimitive
+* gx:Track
+* gx:ViewerOptions
+* gx:w
+* gx:Wait
+* gx:x
+* gx:y
+
 The complete XML schema for elements in this extension namespace is
 located at http://developers.google.com/kml/schema/kml22gx.xsd.
 """