Is there a way to use numpydoc without putting an autosummary table at the head of each class? I'm using numpydoc primarily for the sectionized docstring support, but the autosummaries are somewhat overkill for my project.
Mike
Fri, 23 Oct 2009 09:25:12 -0400, Michael Droettboom wrote:
Is there a way to use numpydoc without putting an autosummary table at the head of each class? I'm using numpydoc primarily for the sectionized docstring support, but the autosummaries are somewhat overkill for my project.
Numpydoc hooks into sphinx.ext.autodoc's docstring mangling. So if you just need to have docstrings formatted, you can use Sphinx's auto*:: directives.
Fri, 23 Oct 2009 09:25:12 -0400, Michael Droettboom wrote:
Is there a way to use numpydoc without putting an autosummary table at the head of each class? I'm using numpydoc primarily for the sectionized docstring support, but the autosummaries are somewhat overkill for my project.
Ah, you meant the stuff output by default to class docstrings. Currently, there's no way to turn this off, unfortunately. It seems there should be, though...
On 10/23/2009 09:39 AM, Pauli Virtanen wrote:
Fri, 23 Oct 2009 09:25:12 -0400, Michael Droettboom wrote:
Is there a way to use numpydoc without putting an autosummary table at the head of each class? I'm using numpydoc primarily for the sectionized docstring support, but the autosummaries are somewhat overkill for my project.
Ah, you meant the stuff output by default to class docstrings. Currently, there's no way to turn this off, unfortunately. It seems there should be, though...
Exactly. It would be great if there was a conf.py option (or something) to turn this off. Thanks for considering it.
Cheers, Mike
The proper thing to do is file an "enhancement" ticket, at:
http://code.google.com/p/pydocweb/issues/list
Thanks.
DG
On Fri, Oct 23, 2009 at 9:13 AM, Michael Droettboom mdroe@stsci.edu wrote:
On 10/23/2009 09:39 AM, Pauli Virtanen wrote:
Fri, 23 Oct 2009 09:25:12 -0400, Michael Droettboom wrote:
Is there a way to use numpydoc without putting an autosummary table at the head of each class? I'm using numpydoc primarily for the sectionized docstring support, but the autosummaries are somewhat overkill for my project.
Ah, you meant the stuff output by default to class docstrings. Currently, there's no way to turn this off, unfortunately. It seems there should be, though...
Exactly. It would be great if there was a conf.py option (or something) to turn this off. Thanks for considering it.
Cheers, Mike _______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@scipy.org http://mail.scipy.org/mailman/listinfo/numpy-discussion
Done. Issue #50.
Thanks, Mike
On 10/23/2009 02:56 PM, David Goldsmith wrote:
The proper thing to do is file an "enhancement" ticket, at:
http://code.google.com/p/pydocweb/issues/list
Thanks.
DG
On Fri, Oct 23, 2009 at 9:13 AM, Michael Droettboom <mdroe@stsci.edu mailto:mdroe@stsci.edu> wrote:
On 10/23/2009 09:39 AM, Pauli Virtanen wrote: > Fri, 23 Oct 2009 09:25:12 -0400, Michael Droettboom wrote: > >> Is there a way to use numpydoc without putting an autosummary table at >> the head of each class? I'm using numpydoc primarily for the >> sectionized docstring support, but the autosummaries are somewhat >> overkill for my project. >> > Ah, you meant the stuff output by default to class docstrings. Currently, > there's no way to turn this off, unfortunately. It seems there should be, > though... > > Exactly. It would be great if there was a conf.py option (or something) to turn this off. Thanks for considering it. Cheers, Mike _______________________________________________ NumPy-Discussion mailing list NumPy-Discussion@scipy.org <mailto:NumPy-Discussion@scipy.org> http://mail.scipy.org/mailman/listinfo/numpy-discussion
NumPy-Discussion mailing list NumPy-Discussion@scipy.org http://mail.scipy.org/mailman/listinfo/numpy-discussion
participants (3)
-
David Goldsmith -
Michael Droettboom -
Pauli Virtanen