#99 Additional Directives in RST

closed
Edward Loper
Other (25)
5
2009-03-18
2008-12-31
Anonymous
No

EPytext has a luscious set of directive-like tags. Specically @note and @todo.

Because I'm also using Sphinx, I'm switching to a docformat of RST. Which doesn't seem to have all the same directives.

There are two specific directives which are essential:

- a ``.. todo::`` directive would mean that my epydoc TODO list matched my sphinx todo list for those few modules which are referenced directly by Sphinx.

- a ``.. note::`` directive to create a proper admonition paragraph.

Discussion

  • Edward Loper
    Edward Loper
    2008-12-31

    • status: open --> pending
     
  • Edward Loper
    Edward Loper
    2008-12-31

    ReST has all the same fields that epytext does; but you don't access them with directives. Instead, you use field lists [1]. E.g.:

    :todo: This is a todo item.
    :todo 3.2: This is a todo item with a version.
    :note: This is a note item.
    :param x: This is a description of parameter x.

    See [2] for more info, including a complete list of directives.

    [1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
    [2] http://epydoc.sourceforge.net/manual-fields.html

    (Unfortunately, you're not logged in, so I'm not sure whether you'll see this response. I'm marking the bug report as pending; which means it will be auto-closed in 14 days.)

     
  • This Tracker item was closed automatically by the system. It was
    previously set to a Pending status, and the original submitter
    did not respond within 14 days (the time period specified by
    the administrator of this Tracker).

     
    • status: pending --> closed