I've been reading through the documentation and source code for
directives both on the sphinx site and rst, but have been unable to
manage adding some simple directives. I am trying to document an API.
One section of this is on response codes the API may send. I'd like to
have a simple directive such as:

.. respcode::

  :code: 0
  :description: The device is idle.

that I can basically just render as:

**Code**: 0
*The device is idle.*

But with proper linebreaks, of course. I'd also like to be able to
reference them elsewhere in the documentation and have index entries
made appropriately. Thus far I've been unable to write a working
directive to accomplish the task above, much less tie it into the
index and such. Does anyone know of a simple example that can help
with this? Docs and Google haven't lead me to something succinct
enough to work with.

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-...@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to