No luck so far. I opted to use a table in the function documentation listing the topic, the arguments, and a description of when it is sent.
I think this works as far as function and method documentation goes. I would like to be able to document the entire topic tree on a single page, like a glossary. Now that I've played with TopicTreeTraversers and Visitors in PyPubSub, I may be able to get a directive working that would document the tree, but I haven't played with it yet. I need to go relearn everything. I'll also look over Takayuki Shimizukawa's code and see if it makes sense to me. On Sun, Jul 7, 2013 at 10:54 PM, Takayuki Shimizukawa <[email protected]> wrote: > Hi, > > I think the extension tutorial page is useful: > > - http://sphinx-doc.org/ext/tutorial.html > - http://docutils.sourceforge.net/docs/howto/rst-directives.html > > And, I think my small source code is close to your purpose: > > - > https://bitbucket.org/shimizukawa/sphinxjp.themes.s6/src/tip/src/sphinxjp/themes/s6/directives.py > > Regards, > -- > Takayuki SHIMIZUKAWA > http://about.me/shimizukawa > > > 2013/7/7 Mark Elston <[email protected]>: >> Hi Josh, >> >> Did you ever get a reply to this? I am running up against something similar >> and could use some pointers as well. >> >> Mark >> >> >> On Monday, May 6, 2013 7:06:44 PM UTC-7, Josh English wrote: >>> >>> I am trying to write a simple extension for Sphinx. What I want to do is >>> build a standard tool for documenting the use of PubSub. >>> >>> Ideally, my rst would include: >>> >>> .. message:: documented-with-keyword >>> :keyword: boring >>> >>> This describes the ``documented-with-keyword`` topic >>> >>> This would likely be inside a function in the real documents. >>> >>> I cannot find a tutorial on directives anywhere. Every tutorial I find >>> talks about roles. >>> >>> I tried a simple file (attached) and built a sample project using >>> quickstart, and I get errors: >>> >>> Error in "message" directive: >>> no content permitted >>> >>> I get this error with or without any content. >>> >>> Can someone point out what I'm doing wrong? A good site that explains >>> this? >>> >>> Thanks. >>> >>> Josh >>> >>> >> -- >> 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. >> >> For more options, visit https://groups.google.com/groups/opt_out. >> >> > > -- > You received this message because you are subscribed to a topic in the Google > Groups "sphinx-users" group. > To unsubscribe from this topic, visit > https://groups.google.com/d/topic/sphinx-users/vFpUgwj7bG0/unsubscribe. > To unsubscribe from this group and all its topics, 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. > For more options, visit https://groups.google.com/groups/opt_out. > > -- Josh English [email protected] http://www.joshuarenglish.com -- 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. For more options, visit https://groups.google.com/groups/opt_out.
