merge with trunk

6 files changed, 157 insertions, 39 deletions

diff --git a/tests/root/_templates/layout.html b/tests/root/_templates/layout.html
index 7f290fc1..82125df8 100644
--- a/tests/root/_templates/layout.html
+++ b/tests/root/_templates/layout.html
@@ -1,4 +1,5 @@
 {% extends "!layout.html" %}
+
 {% block extrahead %}
 {# html_context variable from conf.py #}
 <meta name="hc" content="{{ hckey }}" />
@@ -6,3 +7,9 @@
 <meta name="hc_co" content="{{ hckey_co }}" />
 {{ super() }}
 {% endblock %}
+
+{% block sidebartoc %}
+{# display global TOC in addition to local TOC #}
+{{ super() }}
+{{ toctree(collapse=False, maxdepth=-1) }}
+{% endblock %}
\ No newline at end of file
diff --git a/tests/root/conf.py b/tests/root/conf.py
index a3783511..d8e5de64 100644
--- a/tests/root/conf.py
+++ b/tests/root/conf.py
@@ -25,13 +25,15 @@ today_fmt = '%B %d, %Y'
 exclude_patterns = ['_build', '**/excluded.*']
 keep_warnings = True
 pygments_style = 'sphinx'
+show_authors = True
 
 rst_epilog = '.. |subst| replace:: global substitution'
 
 html_theme = 'testtheme'
 html_theme_path = ['.']
 html_theme_options = {'testopt': 'testoverride'}
-html_sidebars = {'**': 'customsb.html', 'contents': 'contentssb.html'}
+html_sidebars = {'**': 'customsb.html',
+                 'contents': ['contentssb.html', 'localtoc.html'] }
 html_style = 'default.css'
 html_static_path = ['_static', 'templated.css_t']
 html_last_updated_fmt = '%b %d, %Y'
@@ -49,6 +51,7 @@ latex_additional_files = ['svgimg.svg']
 value_from_conf_py = 84
 
 coverage_c_path = ['special/*.h']
+# XXX cfunction?
 coverage_c_regexes = {'cfunction': r'^PyAPI_FUNC\(.*\)\s+([^_][\w_]+)'}
 
 autosummary_generate = ['autosummary']
@@ -59,7 +62,12 @@ extlinks = {'issue': ('http://bugs.python.org/issue%s', 'issue '),
 # modify tags from conf.py
 tags.add('confpytag')
 
+
+# -- extension API
+
+from docutils import nodes
 from sphinx import addnodes
+from sphinx.util.compat import Directive
 
 def userdesc_parse(env, sig, signode):
     x, y = sig.split(':')
@@ -68,7 +76,18 @@ def userdesc_parse(env, sig, signode):
     signode[-1] += addnodes.desc_parameter(y, y)
     return x
 
+def functional_directive(name, arguments, options, content, lineno,
+                         content_offset, block_text, state, state_machine):
+    return [nodes.strong(text='from function: %s' % options['opt'])]
+
+class ClassDirective(Directive):
+    option_spec = {'opt': lambda x: x}
+    def run(self):
+        return [nodes.strong(text='from class: %s' % self.options['opt'])]
+
 def setup(app):
     app.add_config_value('value_from_conf_py', 42, False)
-    app.add_description_unit('userdesc', 'userdescrole', '%s (userdesc)',
-                             userdesc_parse)
+    app.add_directive('funcdir', functional_directive, opt=lambda x: x)
+    app.add_directive('clsdir', ClassDirective)
+    app.add_object_type('userdesc', 'userdescrole', '%s (userdesc)',
+                        userdesc_parse, objname='user desc')
diff --git a/tests/root/contents.txt b/tests/root/contents.txt
index c9005d57..e052e04b 100644
--- a/tests/root/contents.txt
+++ b/tests/root/contents.txt
@@ -11,12 +11,13 @@ Contents:
    :maxdepth: 2
    :numbered:
 
+   extapi
    images
    subdir/images
    subdir/includes
    includes
    markup
-   desc
+   objects
    bom
    math
    autodoc
diff --git a/tests/root/extapi.txt b/tests/root/extapi.txt
new file mode 100644
index 00000000..4728e3de
--- /dev/null
+++ b/tests/root/extapi.txt
@@ -0,0 +1,10 @@
+Extension API tests
+===================
+
+Testing directives:
+
+.. funcdir::
+   :opt: Foo
+
+.. clsdir::
+   :opt: Bar
diff --git a/tests/root/markup.txt b/tests/root/markup.txt
index cdb8c5fc..65156e7e 100644
--- a/tests/root/markup.txt
+++ b/tests/root/markup.txt
@@ -5,7 +5,11 @@
 Testing various markup
 ======================
 
+Meta markup
+-----------
+
 .. sectionauthor:: Georg Brandl
+.. moduleauthor:: Georg Brandl
 
 .. contents:: TOC
 
@@ -13,7 +17,11 @@ Testing various markup
    :author: Me
    :keywords: docs, sphinx
 
-A |subst|.
+
+Generic reST
+------------
+
+A |subst| (the definition is in rst_epilog).
 
 .. _label:
 
@@ -21,22 +29,14 @@ A |subst|.
 
    some code
 
-Admonitions
------------
-
-.. note:: Note
-   Note text.
-
-.. warning:: Warning
-
-   Warning text.
+Option list:
 
-.. tip::
-   Tip text.
+-h              help
+--help          also help
 
 
 Body directives
----------------
+^^^^^^^^^^^^^^^
 
 .. topic:: Title
 
@@ -69,7 +69,67 @@ Body directives
 
    b
 
-   
+
+Admonitions
+^^^^^^^^^^^
+
+.. admonition:: My Admonition
+
+   Admonition text.
+
+.. note::
+   Note text.
+
+.. warning::
+
+   Warning text.
+
+.. tip::
+   Tip text.
+
+
+Inline markup
+-------------
+
+*Generic inline markup*
+
+* :command:`command`
+* :dfn:`dfn`
+* :guilabel:`guilabel`
+* :kbd:`kbd`
+* :mailheader:`mailheader`
+* :makevar:`makevar`
+* :manpage:`manpage`
+* :mimetype:`mimetype`
+* :newsgroup:`newsgroup`
+* :program:`program`
+* :regexp:`regexp`
+* :menuselection:`File --> Close`
+* :file:`a/{varpart}/b`
+* :samp:`print {i}`
+
+*Linking inline markup*
+
+* :pep:`8`
+* :rfc:`1`
+* :envvar:`HOME`
+* :keyword:`with`
+* :token:`try statement <try_stmt>`
+* :doc:`subdir/includes`
+* ``:download:`` is tested in includes.txt
+* :option:`Python -c option <python -c>`
+
+Test :abbr:`abbr (abbreviation)` and another :abbr:`abbr (abbreviation)`.
+
+
+.. _with:
+
+With
+----
+
+(Empty section.)
+
+
 Tables
 ------
 
@@ -96,6 +156,17 @@ Version markup
    Boring stuff.
 
 
+Code blocks
+-----------
+
+.. code-block:: ruby
+   :linenos:
+
+   def ruby?
+       false
+   end
+
+
 Misc stuff
 ----------
 
@@ -124,11 +195,6 @@ This is a side note.
 
 This tests :CLASS:`role names in uppercase`.
 
-Option list:
-
--h              help
---help          also help
-
 .. centered:: LICENSE AGREEMENT
 
 .. acks::
@@ -146,7 +212,7 @@ Option list:
       Particle with half-integer spin.
 
 .. productionlist::
-   try_stmt: try1_stmt | try2_stmt
+   try_stmt: `try1_stmt` | `try2_stmt`
    try1_stmt: "try" ":" `suite`
             : ("except" [`expression` ["," `target`]] ":" `suite`)+
             : ["else" ":" `suite`]
@@ -154,7 +220,6 @@ Option list:
    try2_stmt: "try" ":" `suite`
             : "finally" ":" `suite`
 
-Test :abbr:`abbr (abbreviation)` and another :abbr:`abbr (abbreviation)`.
 
 Index markup
 ------------
@@ -180,11 +245,6 @@ Invalid index markup...
 Testing öäü...
 
 
-Object markup
--------------
-
-:cfunc:`CFunction`.
-
 Only directive
 --------------
 
@@ -208,3 +268,4 @@ Only directive
 .. rubric:: Footnotes
 
 .. [#] Like footnotes.
+
diff --git a/tests/root/desc.txt b/tests/root/objects.txt
index d6915dc2..fd33a6cc 100644
--- a/tests/root/desc.txt
+++ b/tests/root/objects.txt
@@ -1,5 +1,5 @@
-Testing description units
-=========================
+Testing object descriptions
+===========================
 
 .. function:: func_without_module(a, b, *c[, d])
 
@@ -43,22 +43,42 @@ Testing description units
 C items
 =======
 
-.. cfunction:: Sphinx_DoSomething()
+.. c:function:: Sphinx_DoSomething()
 
-.. cmember:: SphinxStruct.member
+.. c:member:: SphinxStruct.member
 
-.. cmacro:: SPHINX_USE_PYTHON
+.. c:macro:: SPHINX_USE_PYTHON
 
-.. ctype:: SphinxType
+.. c:type:: SphinxType
 
-.. cvar:: sphinx_global
+.. c:var:: sphinx_global
 
 
-Testing references
-==================
+References
+==========
 
 Referencing :class:`mod.Cls` or :Class:`mod.Cls` should be the same.
 
+With target: :c:func:`Sphinx_DoSomething()` (parentheses are handled),
+:c:member:`SphinxStruct.member`, :c:macro:`SPHINX_USE_PYTHON`,
+:c:type:`SphinxType *` (pointer is handled), :c:data:`sphinx_global`.
+
+Without target: :c:func:`CFunction`. :c:func:`!malloc`.
+
+
+Others
+======
+
+.. envvar:: HOME
+
+.. program:: python
+
+.. cmdoption:: -c command
+
+.. program:: perl
+
+.. cmdoption:: -c
+
 
 User markup
 ===========