More refactoring for language-independent domain support.

* Renamed "desc"ription unit to "object" wherever possible.
* Added standard x-ref types to a StandardDomain which is always consulted.
* Split domains module into a subpackage.
* Removed additional_xref_types in favor of new directive classes in StandardDomain.
* Implemented x-ref inventory version 2, for all object types.
* Added env.doc_read_data which is for temporary data stored while reading.
* Minimally updated extension tutorial.
* Started to implement changes to interactive search.
* Test suite passes again.

tests/root/contents.txt

@@ -16,7 +16,7 @@ Contents:
    subdir/includes
    includes
    markup
-   desc
+   objects
    bom
    math
    autodoc

tests/test_autodoc.py

@@ -97,28 +97,28 @@ def test_parse_name():
     verify('function', 'util.raises', ('util', ['raises'], None, None))
     verify('function', 'util.raises(exc) -> None',
            ('util', ['raises'], 'exc', 'None'))
-    directive.env.autodoc_current_module = 'util'
+    directive.env.doc_read_data['autodoc_module'] = 'util'
     verify('function', 'raises', ('util', ['raises'], None, None))
-    directive.env.autodoc_current_module = None
-    directive.env.currmodule = 'util'
+    del directive.env.doc_read_data['autodoc_module']
+    directive.env.doc_read_data['py_module'] = 'util'
     verify('function', 'raises', ('util', ['raises'], None, None))
     verify('class', 'TestApp', ('util', ['TestApp'], None, None))
 
     # for members
-    directive.env.currmodule = 'foo'
+    directive.env.doc_read_data['py_module'] = 'foo'
     verify('method', 'util.TestApp.cleanup',
            ('util', ['TestApp', 'cleanup'], None, None))
-    directive.env.currmodule = 'util'
-    directive.env.currclass = 'Foo'
-    directive.env.autodoc_current_class = 'TestApp'
+    directive.env.doc_read_data['py_module'] = 'util'
+    directive.env.doc_read_data['py_class'] = 'Foo'
+    directive.env.doc_read_data['autodoc_class'] = 'TestApp'
     verify('method', 'cleanup', ('util', ['TestApp', 'cleanup'], None, None))
     verify('method', 'TestApp.cleanup',
            ('util', ['TestApp', 'cleanup'], None, None))
 
     # and clean up
-    directive.env.currmodule = None
-    directive.env.currclass = None
-    directive.env.autodoc_current_class = None
+    del directive.env.doc_read_data['py_module']
+    del directive.env.doc_read_data['py_class']
+    del directive.env.doc_read_data['autodoc_class']
 
 
 def test_format_signature():
@@ -353,7 +353,7 @@ def test_generate():
                  'function', 'util.foobar', more_content=None)
 
     # test auto and given content mixing
-    directive.env.currmodule = 'test_autodoc'
+    directive.env.doc_read_data['py_module'] = 'test_autodoc'
     assert_result_contains('   Function.', 'method', 'Class.meth')
     add_content = ViewList()
     add_content.append('Content.', '', 0)
@@ -428,7 +428,7 @@ def test_generate():
                      'class', 'Outer', all_members=True)
 
     # test generation for C modules (which have no source file)
-    directive.env.currmodule = 'time'
+    directive.env.doc_read_data['py_module'] = 'time'
     assert_processes([('function', 'time.asctime')], 'function', 'asctime')
     assert_processes([('function', 'time.asctime')], 'function', 'asctime')
 

tests/test_build.py

@@ -111,11 +111,11 @@ HTML_XPATH = {
         ".//li/tt/em/span[@class='pre']": '^i$',
         ".//a[@href='http://www.python.org/dev/peps/pep-0008']/strong": 'PEP 8',
         ".//a[@href='http://tools.ietf.org/html/rfc1.html']/strong": 'RFC 1',
-        ".//a[@href='desc.html#envvar-HOME']/tt/span[@class='pre']": 'HOME',
+        ".//a[@href='objects.html#envvar-HOME']/tt/span[@class='pre']": 'HOME',
         ".//a[@href='#with']/tt/span[@class='pre']": '^with$',
         ".//a[@href='#grammar-token-try_stmt']/tt/span": '^statement$',
         ".//a[@href='subdir/includes.html']/em": 'Including in subdir',
-        ".//a[@href='desc.html#cmdoption-python-c']/em": 'Python -c option',
+        ".//a[@href='objects.html#cmdoption-python-c']/em": 'Python -c option',
         # abbreviations
         ".//abbr[@title='abbreviation']": '^abbr$',
         # version stuff
@@ -141,13 +141,13 @@ HTML_XPATH = {
         ".//p": 'In both.',
         ".//p": 'Always present',
     },
-    'desc.html': {
+    'objects.html': {
         ".//dt[@id='mod.Cls.meth1']": '',
         ".//dt[@id='errmod.Error']": '',
         ".//a[@href='#mod.Cls']": '',
         ".//dl[@class='userdesc']": '',
-        ".//dt[@id='userdescrole-myobj']": '',
-        ".//a[@href='#userdescrole-myobj']": '',
+        ".//dt[@id='userdesc-myobj']": '',
+        ".//a[@href='#userdesc-myobj']": '',
         ".//span[@class='pre']": 'CFunction()',
     },
     'contents.html': {

tests/test_env.py

@@ -95,7 +95,7 @@ def test_object_inventory():
     refs = env.domaindata['py']['objects']
 
     assert 'func_without_module' in refs
-    assert refs['func_without_module'] == ('desc', 'function')
+    assert refs['func_without_module'] == ('objects', 'function')
     assert 'func_without_module2' in refs
     assert 'mod.func_in_module' in refs
     assert 'mod.Cls' in refs
@@ -110,7 +110,7 @@ def test_object_inventory():
     assert 'func_noindex' not in refs
 
     assert env.domaindata['py']['modules']['mod'] == \
-        ('desc', 'Module synopsis.', 'UNIX', False)
+        ('objects', 'Module synopsis.', 'UNIX', False)
 
     assert env.domains['py'].data is env.domaindata['py']
     assert env.domains['c'].data is env.domaindata['c']