[sage-support] Re: Help on creating documentation for an spkg

2009-06-10 Thread Mike Hansen
On Tue, Jun 9, 2009 at 11:27 PM, wrote: > ... and my problem was that I expected (from the sage manual) that > these short .rst files are auto-generated! Aren't they? They're only auto-generated because I put code in builder.py to do so. For something that's not Sage, I don't know if I'd use bu

[sage-support] Re: Help on creating documentation for an spkg

2009-06-09 Thread simon . king
Dear Mike, On Jun 9, 9:44 pm, Mike Hansen wrote: > The reference manual is not the most straightforward place to start > looking since there is some additional stuff that we do in > devel/doc/common/builder.py to make it easy to add Sage modules to the > reference manual. Actually this is what

[sage-support] Re: Help on creating documentation for an spkg

2009-06-09 Thread Mike Hansen
Hello, On Tue, Jun 9, 2009 at 1:57 AM, Simon King wrote: > How can I tell sphinx where the modules-to-be-documented are? Sphinx just tries to import the modules. It reads the docstrings, etc. via introspection. So, they just need to be somewhere where they can be imported by Python. > Looking

[sage-support] Re: Help on creating documentation for an spkg

2009-06-09 Thread simon . king
PS: Yes, my conf.py defines extensions = ['sphinx.ext.autodoc'], and yes, I use sphinx within a sage-shell. Cheers, Simon --~--~-~--~~~---~--~~ To post to this group, send email to sage-support@googlegroups.com To unsubscribe from this group, send email to s