Add tests for the sphinx extension, raising the total coverage over 95%

.hgignore

@@ -10,6 +10,7 @@ syntax: glob
 coverage.xml
 .noseids
 .tox
+.test_sphinxext
 nosetests.xml
 
 syntax: regexp

tests/sphinxexample/conf.py

@@ -0,0 +1,230 @@
+# -*- coding: utf-8 -*-
+#
+# Web Services Made Easy documentation build configuration file, created by
+# sphinx-quickstart on Sun Oct  2 20:27:45 2011.
+#
+# 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.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', 'wsme.sphinxext']
+
+# 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'wsme.sphinxext Test'
+copyright = u'2011, Christophe de Vienne'
+
+# 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.
+#
+import wsme.release
+# The short X.Y version.
+version = '.'.join(wsme.release.version.split('.')[:2])
+# The full version, including alpha/beta/rc tags.
+release = wsme.release.version
+
+# 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 = []
+
+
+# -- 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 = 'agogo'
+html_theme_options = {
+    "pagewidth": "60em",
+    "documentwidth": "40em",
+}
+
+html_style = 'wsme.css'
+
+# 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 = "WSME %s" % release
+
+# 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_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 = 'WebServicesMadeEasydoc'
+
+
+# -- 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', 'WebServicesMadeEasy.tex', u'Web Services Made Easy Documentation',
+   u'Christophe de Vienne', '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
+
+# 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_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', 'webservicesmadeeasy', u'Web Services Made Easy Documentation',
+     [u'Christophe de Vienne'], 1)
+]
+
+
+autodoc_member_order = 'bysource'
+
+wsme_protocols = [
+    'restjson', 'restxml'
+]

tests/sphinxexample/document.rst

@@ -0,0 +1,43 @@
+API Documentation test
+======================
+
+Example
+~~~~~~~
+
+.. wsme:root:: wsme.sphinxext.SampleService
+    :webpath: /api
+
+.. wsme:type:: MyType
+
+    .. wsme:attribute:: test
+
+        :type: int
+
+.. wsme:service:: name/space/SampleService
+    
+    .. wsme:function:: getType
+        
+        Returns a :wsme:type:`MyType <MyType>`
+
+
+.. default-domain:: wsme
+
+.. type:: int
+
+    An integer
+
+.. autotype:: wsme.sphinxext.SampleType
+    :members:
+
+.. autoservice:: wsme.sphinxext.SampleService
+    :members:
+
+
+.. autotype:: test_sphinxext.ASampleType
+    :members:
+
+.. autotype:: wsme.types.bytes
+
+.. autotype:: wsme.types.text
+
+.. _Sphinx: http://sphinx.pocoo.org/

tests/sphinxexample/index.rst

@@ -0,0 +1,3 @@
+.. toctree::
+
+    document

tests/test_sphinxext.py

@@ -0,0 +1,26 @@
+import unittest
+import sphinx
+import os.path
+
+import wsme.types
+
+docpath = os.path.join(
+    os.path.dirname(__file__),
+    'sphinxexample')
+
+
+class ASampleType(object):
+    somebytes = wsme.types.bytes
+    sometext = wsme.types.text
+    someint = int
+
+
+class TestSphinxExt(unittest.TestCase):
+    def test_buildhtml(self):
+        if not os.path.exists('.test_sphinxext/'):
+            os.makedirs('.test_sphinxext/')
+        assert sphinx.main(['',
+            '-b', 'html',
+            '-d', '.test_sphinxext/doctree',
+            docpath,
+            '.test_sphinxext/html']) == 0

tox.ini

@@ -1,6 +1,6 @@
 # content of: tox.ini , put in same dir as setup.py
 [tox]
-envlist = py27,py32,pypy,py25simplejson,tg11,tg15,coverage
+envlist = py27,py32,pypy,py25simplejson,sphinxext,tg11,tg15,coverage
 indexserver =
     TG15 = http://www.turbogears.org/1.5/downloads/current/index
     TG20 = http://www.turbogears.org/2.0/downloads/current/index
@@ -34,6 +34,15 @@ deps=
     simplejson
     transaction<=1.1.1
 
+[testenv:sphinxext]
+basepython=python2.5
+deps=
+    nose
+    coverage
+    simplejson
+    Sphinx
+commands=
+    {envbindir}/coverage run -p {envbindir}/nosetests tests/test_sphinxext.py --verbose {posargs}
 
 [testenv:tg11]
 basepython=python2.5

wsme/sphinxext.py

@@ -17,14 +17,15 @@ from docutils.parsers.rst import Directive
 from docutils.parsers.rst import directives
 
 import wsme
+import wsme.types
 
 field_re = re.compile(r':(?P<field>\w+)(\s+(?P<name>\w+))?:')
 
 
 def make_sample_object(datatype):
-    if datatype is str:
+    if datatype is wsme.types.bytes:
         return 'samplestring'
-    if datatype is unicode:
+    if datatype is wsme.types.text:
         return u'sample unicode'
     if datatype is int:
         return 5