Hi. I've been using Sphinx for a little while for Stem, a python library for Tor...
https://stem.torproject.org/ http://www.torproject.org/ Many thanks to the Sphinx developers, it has made documentation far nicer! One thing I've been struggling with though are module overviews. I'd like to provide a succinct summary of a module's contents, preferably in a tree form so I can express inheritance. Presently I'm doing this via ascii art in pre-formatted text blocks. For example... https://stem.torproject.org/api/connection.html https://stem.torproject.org/api/control.html ... but this lacks an important feature for an overview: interlinking. Is it possible to somehow include directives (:func:, :data:, etc) within a pre-formatted text block or something similar? I'm only aiming for html documentation, in case that opens some additional options. I briefly looked into graphviz and blockdiag after reading a prior thread that was a little similar... http://www.mail-archive.com/[email protected]/msg05237.html ... but the results weren't very compact. On a side note I'd love it if Sphinx had a :tree: directive. :) Thanks! -Damian PS. If anyone has an alternative method for doing module overviews that they think works well then I'd love to see it! -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
