[hide private]
[frames] | no frames]

[ Identifiers | Term Definitions | Bugs | To Do ]

# To Do List

To Do in epydoc

- Create a better default top_page than trees.html.
- Fix trees.html to work when documenting non-top-level modules/packages
- Implement @include
- Optimize epytext
- More doctests
- When introspecting, limit how much introspection you do (eg, don't construct docs for imported modules' vars if it's not necessary)

To Do in epydoc.apidoc

- Add a cache to canonical name lookup?

To Do in epydoc.docparser

- Make it possible to extend the functionality of `parse_docs()`, by replacing process_line with a dispatch table that can be customized (similarly to `docintrospector.register_introspector()`).

To Do in epydoc.docwriter.dotgraph.DotGraphUmlClassNode

- Add more options? - show/hide operation signature - show/hide operation signature types - show/hide operation signature return type - show/hide attribute types - use qualifiers

To Do in epydoc.docwriter.dotgraph.DotGraphUmlClassNode._operation_arg

- Handle tuple args better
- Optionally add type info?

To Do in epydoc.docwriter.dotgraph.DotGraphUmlClassNode._operation_cell

- do 'word wrapping' on the signature, by starting a new row in the table, if necessary. How to indent the new line? Maybe use align=right? I don't think dot has a &nbsp;.
- Optionally add return type info?

To Do in epydoc.docwriter.dotgraph.add_valdoc_nodes

- Use different node styles for different subclasses of APIDoc

To Do in epydoc.docwriter.dotgraph.call_graph

- Add an `exclude` option?

To Do in epydoc.docwriter.html

- Add a cache to HTMLWriter.url()?

To Do in epydoc.docwriter.html.HTMLWriter.write_class_tree

- For multiple inheritance, don't repeat subclasses the second time a class is mentioned; instead, link to the first mention.

To Do in epydoc.docwriter.latex

- Inheritance=listed

To Do in epydoc.gui

- Use ini-style project files, rather than pickles (using the same format as the CLI).

To Do in epydoc.markup.restructuredtext

- Add ParsedRstDocstring.to_latex()