Add glossary entries to the index. Update TODO.

This commit is contained in:
Georg Brandl 2008-08-07 18:29:48 +00:00
parent cdeaa1e1c9
commit e34a6e22a6
3 changed files with 9 additions and 4 deletions

View File

@ -35,6 +35,8 @@ New features added
* sphinx.doc.autodoc has a new event ``autodoc-process-signature`` * sphinx.doc.autodoc has a new event ``autodoc-process-signature``
that allows tuning function signature introspection. 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 * ``Sphinx.add_node()`` now takes optional visitor methods for the
HTML, LaTeX and text translators; this prevents having to manually HTML, LaTeX and text translators; this prevents having to manually
patch the classes. patch the classes.

6
TODO
View File

@ -2,11 +2,10 @@ Sphinx TODO
=========== ===========
- RSS generation - RSS generation
- extension autodoc directives
- files for downloading - files for downloading
- specify node visit functions when adding nodes to app - specify node visit functions when adding nodes to app
- allow extensions to add static files
- decide which static files to include - decide which static files to include
- verbose option
- remove redundant <ul>s in tocs - remove redundant <ul>s in tocs
- autoattribute in autodoc - autoattribute in autodoc
- section, range and object options for literalinclude - section, range and object options for literalinclude
@ -14,6 +13,5 @@ Sphinx TODO
- option for compact module index - option for compact module index
- HTML section numbers? - 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 - "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 (codelinks extension)
- source file cross-references?

View File

@ -314,6 +314,11 @@ def glossary_directive(name, arguments, options, content, lineno,
li[0]['ids'].append(new_id) li[0]['ids'].append(new_id)
state.document.settings.env.note_reftarget('term', termtext.lower(), state.document.settings.env.note_reftarget('term', termtext.lower(),
new_id) 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] return [node]
glossary_directive.content = 1 glossary_directive.content = 1