That's great, I should have RTFM :-) Thanks a lot

2008/10/6 Pauli Virtanen <[EMAIL PROTECTED]>

>
> Mon, 06 Oct 2008 08:02:09 -0700, boothead wrote:
>
> > Hi All,
> >
> > Thanks first of all for a wonderful piece of software, sphinx has made
> > an awesome difference to our codebase and documentation!
> >
> > I've just started a subproject and I'm trying to integrate some 3rd
> > party docs into my documentation (specifically I'm building something on
> > top of the superb boto library). Docstrings in this library are in
> > epydoc markup, e.g:
> >
> >   @type fp: file
> >   @param fp: The file pointer to upload
> >
> > I've already fixed up the written documentation to go into mine, I
> > wonder how easy it would be to recognise and format the above style so
> > that I can still use .. autowhatever:: in my docs and have pretty
> > output. I see a lot of docs with this kind of thing in and it'd be great
> > to be able to integrate my sphinx docs with them.
> >
> > If someone could point me in the right direction I'd be quite willing to
> > contribute anything I come up with back to sphinx.
>
> You can use the "autodoc-process-docstring" event to reformat the
> docstrings on the fly, see [1].
>
> .. [1]
> http://sphinx.pocoo.org/ext/autodoc.html#event-autodoc-process-docstring
>
> --
> Pauli Virtanen
>
>
> >
>


-- 
Regards,
Ben Ford
[EMAIL PROTECTED]
+447792598685

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

Reply via email to