Autosummary Extension

[Casey McGinty]

Can someone point me the documentation on the "new" autosummary extension?

I want to try this out but can't really find any info about it on the homepage. Is it "production" ready yet?

- Casey

[Pauli Virtanen]

The version in the Sphinx development branch should be almost production
ready; the documentation for the development version is here:

http://sphinx.pocoo.org/latest/ext/autosummary.html

The one in 0.6 has partial functionality, AFAIK.

--
Pauli Virtanen

[Casey McGinty]

On Thu, May 7, 2009 at 9:53 AM, Pauli Virtanen <p...@iki.fi> wrote:

The version in the Sphinx development branch should be almost production
ready; the documentation for the development version is here:

       http://sphinx.pocoo.org/latest/ext/autosummary.html

The one in 0.6 has partial functionality, AFAIK.

Thanks. I got the 1.0-dev branch running. The problem now is that autosummary can't find my local source modules. Should it be picking up my sys.path value value from conf.py?

I'm getting "Failed to import" errors from 'sphinx-autogen' command.

- Casey

[Casey McGinty]

On Sun, May 10, 2009 at 10:32 PM, Casey McGinty <casey....@gmail.com> wrote:

Thanks. I got the 1.0-dev branch running. The problem now is that autosummary can't find my local source modules. Should it be picking up my sys.path value value from conf.py?

I'm getting "Failed to import" errors from 'sphinx-autogen' command.

Sorry to keep adding onto this thread, but I'm still getting bad output. I looked over the 'autosummary_generate' option for conf.py. What happens when the :toctree: option has no directory specified? Is the :toctree: DIRNAME value required? If so, then Sphinx does not report an error when there is no DIRNAME value. I would think it would default to the current directory.

[Casey McGinty]

I think some of my earlier problems were caused by not doing a "make clean" after adding autosummary commands to my docs. My old document directives were conflicting somehow and causing some weird errors.

[Timmie]

>        http://sphinx.pocoo.org/latest/ext/autosummary.html
This must be new in that place.

I have been fiddeling with this...
I do not really understand how the configuration for this works:
http://sphinx.pocoo.org/latest/ext/autosummary.html#generating-stub-pages-automatically

Why is this not a boolean value and autogen would go thorugh my source
files and look for autosummary directives with toctree and generate
stubs for these?

Thanks,
Timmie

[Pauli Virtanen]

Good question. We probably have still time to change this.

--
Pauli Virtanen

[Tim Michelsen]

>> Why is this not a boolean value and autogen would go thorugh my source
>> files and look for autosummary directives with toctree and generate
>> stubs for these?
>
> Good question. We probably have still time to change this.

I added an issue at:
http://bitbucket.org/birkenfeld/sphinx/issue/165/autosummary-improve-confpy-entry

Thanks in advance for your efforts.

Kind regards,
Timmie

[Georg Brandl]

Pauli Virtanen schrieb:

Maybe "autosummary_generate_all = True"?

Georg

[Pauli Virtanen]

Tue, 12 May 2009 23:40:35 +0200, Tim Michelsen wrote:

>>> Why is this not a boolean value and autogen would go thorugh my source
>>> files and look for autosummary directives with toctree and generate
>>> stubs for these?
>>
>> Good question. We probably have still time to change this.
> I added an issue at:
> http://bitbucket.org/birkenfeld/sphinx/issue/165/autosummary-improve-
confpy-entry

Implemented in http://bitbucket.org/pv/sphinx-work/

--
Pauli Virtanen

[Georg Brandl]

Pauli Virtanen schrieb:

And merged into trunk. Thanks!

Georg