[Python-checkins] r65576 - in doctools/trunk: CHANGES TODO sphinx/directives/other.py

georg.brandl python-checkins at python.org
Thu Aug 7 20:30:01 CEST 2008


Author: georg.brandl
Date: Thu Aug  7 20:29:48 2008
New Revision: 65576

Log:
Add glossary entries to the index. Update TODO.


Modified:
   doctools/trunk/CHANGES
   doctools/trunk/TODO
   doctools/trunk/sphinx/directives/other.py

Modified: doctools/trunk/CHANGES
==============================================================================
--- doctools/trunk/CHANGES	(original)
+++ doctools/trunk/CHANGES	Thu Aug  7 20:29:48 2008
@@ -35,6 +35,8 @@
 * sphinx.doc.autodoc has a new event ``autodoc-process-signature``
   that allows tuning function signature introspection.
 
+* Glossary entries are now automatically added to the index.
+
 * ``Sphinx.add_node()`` now takes optional visitor methods for the
   HTML, LaTeX and text translators; this prevents having to manually
   patch the classes.

Modified: doctools/trunk/TODO
==============================================================================
--- doctools/trunk/TODO	(original)
+++ doctools/trunk/TODO	Thu Aug  7 20:29:48 2008
@@ -2,11 +2,10 @@
 ===========
 
 - RSS generation
+- extension autodoc directives
 - files for downloading
 - specify node visit functions when adding nodes to app
-- allow extensions to add static files
 - decide which static files to include
-- verbose option
 - remove redundant <ul>s in tocs
 - autoattribute in autodoc
 - section, range and object options for literalinclude
@@ -14,6 +13,5 @@
 - option for compact module index
 - HTML section numbers?
 - "seealso" links to external examples, see http://svn.python.org/projects/sandbox/trunk/seealso/ and http://effbot.org/zone/idea-seealso.htm
-- "often used" combo box in sidebar
-- source file cross-references?
+- source file cross-references (codelinks extension)
 

Modified: doctools/trunk/sphinx/directives/other.py
==============================================================================
--- doctools/trunk/sphinx/directives/other.py	(original)
+++ doctools/trunk/sphinx/directives/other.py	Thu Aug  7 20:29:48 2008
@@ -314,6 +314,11 @@
             li[0]['ids'].append(new_id)
             state.document.settings.env.note_reftarget('term', termtext.lower(),
                                                        new_id)
+            # add an index entry too
+            indexnode = addnodes.index()
+            indexnode['entries'] = [('single', termtext, new_id, termtext)]
+            env.note_index_entry('single', termtext, new_id, termtext)
+            li.insert(0, indexnode)
     return [node]
 
 glossary_directive.content = 1


More information about the Python-checkins mailing list