generate stub
documentation pages for items included in
autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary
listings.
For example, the command
$ sphinx-autogen -o generated *.rst
please what is your operation system, and python version? are you verified
in
autosummaryhttp://sphinx.pocoo.org/latest/ext/autosummary.html#directive-autosummary
listings.
For example, the command
$ sphinx-autogen -o generated *.rst
please what is your operation system, and python version? are you verified
variables PATH and PYTHONPATH to assure that they point for your new
Hello --
I don't think needs_sphinx is relevant, as I know what sphinx I am using
and my understanding is that using this setting would cause sphinx to error
if I try to use an older sphinx.
I have read everything I could find about autogen and autosummary. I am
able to successfully use
to error
if I try to use an older sphinx.
I have read everything I could find about autogen and autosummary. I am
able to successfully use these settings, and automatically generate
documentation for my python classes. The problem that I am having is that
the table list of methods
why one has the xref but
the other one does not.
-Lisa
On Friday, August 17, 2012 12:29:16 PM UTC-7, Lisa Zorn wrote:
Hello --
I was using sphinx 1.0.7 and autosummary to generate html for my python
module. I recently upgraded to sphinx 1.1.3 and now for the class pages,
the methods
for is a way to
remove the list of function names from the autosummary and have use the
list of functions I've manually listed. Is this the job for a Sphinx
extension?
.. module:: CoreExceptionHandler
Handling Errors
---
.. autosummary::
:nosignatures:
HandleException
Hello --
I was using sphinx 1.0.7 and autosummary to generate html for my python
module. I recently upgraded to sphinx 1.1.3 and now for the class pages,
the methods no longer link to their documentation.
old:
http://dta.googlecode.com/git-history/4f593ec661fe5309ad0af5f027aefb02519fd726/doc
FWIW -- it was indeed a reincarnation of
bugs.debian.org/611078
and patch
http://patch-tracker.debian.org/patch/series/view/sphinx/1.1.2+dfsg-4/initialize_autodoc.diff
present in Debian's 1.1.2+dfsg-4 revision resolved it
Cheers,
Hi to everyone and Georg and Pauli in particular ;)
Was
generated (only) files for
(sub)modules carried no information about methods/functions etc.
Looking into the sphinx code I saw refactoring in
autosummary/__init__.py:get_documenter
to rely on
AutoDirective._registry
to get a correct documenter for a given object... but I could not see
how
*bump* Anyone?
--
You received this message because you are subscribed to the Google Groups
sphinx-dev group.
To view this discussion on the web visit
https://groups.google.com/d/msg/sphinx-dev/-/51reGAKx9t8J.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe
Hi,
I recently began using autosummary along with numpydoc to generate code
reference docs. When I build the docs (using Sphinx 1.1.2), however, I get
a large number of warning messages of the form:
None:None: WARNING: toctree contains reference to nonexisting document
'reference/generated
Hi. I'm using autosummary with a Python project, but the generated
docs include all functions and classes defined in a module,
irrespective of the value of __all__. Sphinx's change history says
that v. 0.5 Respect __all__ when autodocumenting module members, but
this does not seem to be the case
Hello,
I have a question about documenting module functions with the
autosummary directive.
The python module i want to document looks like this
** test.py
A test module
=
The test functions
--
.. currentmodule
Hi. I have some questions regarding templates and autosummary.
I have a simple .rst file with the following:
begin of mypackages.rst
.. autosummary::
:toctree: modulos
pyproj.modulo1
pyproj.modulo2
pyproj.pack1.modulo3
end of mypackages.rst
and my conf.py has
an autosummary_generate list of index files in
the examples directory that read like::
--
Diffusion Examples
--
.. autosummary::
:toctree: generated
examples.diffusion.mesh1D
examples.diffusion.mesh20x20
examples.diffusion.circle
Previously
I'm trying to write an extension to make a version of autosummary that
behaves something like a hybrid between the automodule directive
(with :members:) and autosummary. That is, I want it to be like
autosummary, but instead of explicitly specifying all of the members
to make autosummary stub
On Feb 27, 7:18 am, Justin Rosen jmylesro...@gmail.com wrote:
Hey Everyone,
I've been reading this group for a while but have yet to post.
I'm trying to use autosummary to produce a table with docstring summaries.
Only problem is I'm not getting the docstring summaries! Does this only
Hey Everyone,
I've been reading this group for a while but have yet to post.
I'm trying to use autosummary to produce a table with docstring summaries.
Only problem is I'm not getting the docstring summaries! Does this only
work if using a toctree within autosummary
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 11.01.2010 18:16, schrieb Ciantic:
Hi!
I decided to post also here, I have implemented a way to get
submodules working for autosummary extension.
Also I implemented to autosummary to respect __all__ of package/
module. This is changes
have implemented a way to get
submodules working for autosummary extension.
Also I implemented to autosummary to respect __all__ of package/
module. This is changes behavior, but I think not that many people are
yet using autosummary, since there was bug where all Classes were
included
I think what is trying to be said is the following:
If you are taking too much time making custom templates for your
autosummary stubs, it might be a better idea to write your own
description of the stub, and not use the automatically created ones.
Custom narrative documentation = your own words
On 2009-08-29, Timmie timmichel...@gmx-topmail.de wrote:
Dear Sphinx developers,
I have encountered some issues with the autosummary extension.
I like that extension a lot and it has improved well.
Please have a look here:
* autosummary: generated stub files are not re-written -
http
Dear Sphinx developers,
I have encountered some issues with the autosummary extension.
I like that extension a lot and it has improved well.
Please have a look here:
* autosummary: generated stub files are not re-written -
http://bitbucket.org/birkenfeld/sphinx/issue/247/autosummary-generated
Hello,
are my docs wrong or is the extension autosummary broken?
I receive this error:
Exception occurred:
File
/usr/local/lib/python2.6/dist-packages/Sphinx-1.0dev_20090713-py2.6.egg/sphinx/ext/autosummary/__init__.py,
line 146, in get_documenter
if issubclass(obj, Exception
The TypeError should maybe nonetheless be caught in autosummary,
so it's also a bug.
thanks for the promt answer.
The report is at:
autogen aborts -
http://bitbucket.org/birkenfeld/sphinx/issue/217/autogen-aborts
--~--~-~--~~~---~--~~
You received
Hi,
I'm interested in using autosummary to create a table at the top of all my
module rest documents. Is this possible without explicitly listing all of
the elements in the autosummary directive? I want to avoid having and
explicit autosummary list, since it would limit the usefullness
Pauli Virtanen schrieb:
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
Tue, 12 May 2009 23:27:17 +0200, Tim Michelsen wrote:
I would like to use autosummary to create a list of script files and
then use the generated stub files to show their top docstrings. But if
my script also contains functions, it will create a stub file like:
[clip]
I think some
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
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
/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?
Good question. We probably have still time to change this.
Maybe
#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?
Good question. We probably have still time to change this.
--
Pauli Virtanen
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
On Sun, May 10, 2009 at 10:32 PM, Casey McGinty casey.mcgi...@gmail.comwrote:
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
Hello,
I would like to use autosummary to create a list of script files and
then use the generated stub files to show their top docstrings.
But if my script also contains functions, it will create a stub file
like:
:mod:`scripts.myscript`
===
.. automodule
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
--~--~-~--~~~---~--~~
You received this message because you are subscribed
Wed, 06 May 2009 23:27:48 -1000, Casey McGinty wrote:
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?
The version in the Sphinx development branch should
Pauli Virtanen schrieb:
Mon, 13 Apr 2009 08:32:30 -0700, matthias.troff...@gmail.com wrote:
.. autosummary::
:toctree:
toplevelmodulename
is broken; the patch below is a quick fix.
Thanks, fixed in my branch.
And pulled into main.
Georg
Pauli Virtanen schrieb:
Hi Georg,
Please consider pulling
http://bitbucket.org/pv/sphinx-work/
for fixes and features from the current Numpy version of the autosummary
extension.
The following features are added:
- include signatures and summary lines in the summary
Mon, 13 Apr 2009 08:44:12 +, Georg Brandl wrote:
[clip]
I've now pulled and merged your branch -- many thanks for the big help!
Thanks! I've now marked the Numpy version of the extension as deprecated.
I've also got two new cleanups and bugfixes in my branch, which would be
useful to pull
.. autosummary::
:toctree:
toplevelmodulename
is broken; the patch below is a quick fix.
--Matthias
# HG changeset patch
# User Matthias Troffaes matthias.troff...@gmail.com
# Date 1239635784 -3600
# Node ID 18a6bbf34a878073afaa3996202d21271b218660
# Parent
Pauli Virtanen schrieb:
Hi Georg,
Please consider pulling
http://bitbucket.org/pv/sphinx-work/
for fixes and features from the current Numpy version of the autosummary
extension.
The following features are added:
- include signatures and summary lines in the summary
Hi Georg,
Please consider pulling
http://bitbucket.org/pv/sphinx-work/
for fixes and features from the current Numpy version of the autosummary
extension.
The following features are added:
- include signatures and summary lines in the summary tables
- sphinx-autogen recurses
Sat, 04 Apr 2009 21:07:28 +, Pauli Virtanen wrote:
Please consider pulling
http://bitbucket.org/pv/sphinx-work/
for fixes and features from the current Numpy version of the autosummary
extension.
Note that the tip commit 3e1f33ab8245 may be a bit more racy than the
others
Gael Varoquaux schrieb:
In particular, I have in mind the autosummary directive, and the
only_directive. Both are all over the place in different projects.
Autosumary has been discussed here, only_directive can be found by
googling, but for a quick view, here is an URL:
https
On Thu, Feb 19, 2009 at 10:15:23PM +0100, Georg Brandl wrote:
Gael Varoquaux schrieb:
In particular, I have in mind the autosummary directive, and the
only_directive. Both are all over the place in different projects.
Autosumary has been discussed here, only_directive can be found
Roman schrieb:
On Feb 16, 1:04 am, Georg Brandl ge...@python.org wrote:
percious schrieb:
Thanks Georg,
When is 0.6 scheduled for release?
Soon!
I'd like to use this as an opportunity to talk a bit about 0.6:
the inclusion of autosummary and/or an autogen script is the last
thing
Gael Varoquaux schrieb:
On Mon, Feb 16, 2009 at 12:04:01AM +0100, Georg Brandl wrote:
I'd like to use this as an opportunity to talk a bit about 0.6:
the inclusion of autosummary and/or an autogen script is the last
thing missing now.
Can I ask for the only_directive too? I believe
percious schrieb:
Thanks Georg,
When is 0.6 scheduled for release?
Soon!
I'd like to use this as an opportunity to talk a bit about 0.6:
the inclusion of autosummary and/or an autogen script is the last
thing missing now.
What has landed in trunk today is improved theming support, which I
On Feb 16, 1:04 am, Georg Brandl ge...@python.org wrote:
percious schrieb:
Thanks Georg,
When is 0.6 scheduled for release?
Soon!
I'd like to use this as an opportunity to talk a bit about 0.6:
the inclusion of autosummary and/or an autogen script is the last
thing missing now
Hey guys, I will be giving a talk on Sphinx at Pycon this year, and
I'd like to know if you have been able to merge my branch which is at:
http://bitbucket.org/percious/sphinx-autosummary/ Autosummary is an
integral part of my screencasts, which I would also like to update on
showmedo
Just a quick note: I've looked at the repo, and I'll go over the code soon.
I don't want to add the whole thing to 0.5 -- that will be out soon and
has already enough new features. Instead, we can let autosummary mature,
and include it in 0.6 (which won't be as long as 0.5 was from 0.4, I promise
alternative way to find the signature.
Internally, sphinx.ext.autodoc calls these user-provided functions,
through its signal mechanism. (Look for 'emit' in autodoc.py)
Since autosummary needs to display probably at least a list of function
summaries, it would be useful for the user to have control over
Thanks for finding that bug Paul!
And yes, there is a ton of functionality in the Numpy stuff. I wanted
a good base to build from, and a clean slate to pull in intelligible
numpy stuff.
- Hooking autosummary into the same autodoc-process-docstring
and autodoc-process-signature signal
stuff.
- Hooking autosummary into the same autodoc-process-docstring
and autodoc-process-signature signal as sphinx.ext.autodoc
would be nice.
Can you explain what you mean a little more by this.
- I'd recommend retaining the signature formatting functionality -- it's
probably
To whom it may concern, I have started my own autosummary branch at:
http://bitbucket.org/percious/sphinx-autosummary/
I will keep you abreast when I think I have something worthy of
merging with trunk.
cheers!
-chris
On Nov 2, 3:38 am, Nicola Larosa (tekNico) [EMAIL PROTECTED]
wrote:
Georg
Georg Brandl wrote:
So, I'm asking all of you: what would you prefer -- SVN at Google,
with very liberal commit policies, or Mercurial?
I'll cast my vote too, FWIW.
+1 for Mercurial.
+0 for Bazaar-NG.
-1 for git. Let's be pythonic in tools too, as far as possible.
--
Nicola Larosa -
On Sat, Nov 01, 2008 at 04:14:10PM +0100, Georg Brandl wrote:
So, I'm asking all of you: what would you prefer -- SVN at Google,
with very liberal commit policies, or Mercurial?
My experience is that DVCS makes a big difference. I really enjoy it.
Gaël
On Sat, Nov 1, 2008 at 4:14 PM, Georg Brandl [EMAIL PROTECTED] wrote:
So, I'm asking all of you: what would you prefer -- SVN at Google,
with very liberal commit policies, or Mercurial?
i'm not (yet) a contributor, but i'm working extensivly with sphinx
last month and will continue in the
DVCS is nice - and lightweight on a potential contributor's local machine..
Could we keep it python-ish, so that contributing platforms don't get in the
way?
The nice thing about SVN is is seems to run everywhere
mercurial too (but you need to compile C code if not);
bazaar is all python;
I'm using everything Launchpad, including Bazaar, for my project. That said,
I'm still learning DVCS and Bazaar, but I like all the support tools that
Launchpad provides, and that they're all in one place, and that there's
money behind development.
On Sat, Nov 1, 2008 at 12:15 PM, Yarko T [EMAIL
On Sat, Nov 1, 2008 at 19:15, Yarko T [EMAIL PROTECTED] wrote:
I'd vote for one of the later two (hg or bzr). In fact, I've found a most
of what I need bazaar site (launchpad), but not found a hosting place
similarly configured for hg, so would be curious to hear what other people
are using
alternate possibility to directly take the step to a DVCS.
So, I'm asking all of you: what would you prefer -- SVN at Google,
with very liberal commit policies, or Mercurial?
While I am not contributing to sphinx, I'd like to support the vote
for Mercurial. I have used over the years cvs
I used to be on the hg end also - but I was participating in projects on
Launchpad; that started to erode my preference I think later (1.5?)
releases of bzr are snappier...
Anyway - the supporting environment is important (look at sourceforge,
code.google, launchpad...)
Sebastian: thanks
I think Project Kenai bears more looking into (at least by me...)... At
first look, it seems pretty feature reach.
On Sat, Nov 1, 2008 at 2:46 PM, Sebastien Douche [EMAIL PROTECTED] wrote:
On Sat, Nov 1, 2008 at 19:15, Yarko T [EMAIL PROTECTED] wrote:
I'd vote for one of the later two (hg
percious schrieb:
Thanks George,
Is the code at googlecode most update with what is in the python svn?
I just want to make sure I am updating the correct thing before I go
making a branch of an older version.
I don't know -- the Google repo isn't managed by me. But from the commit
date it
On Fri, Oct 24, 2008 at 01:52, percious [EMAIL PROTECTED] wrote:
numpyext is now easy_installable. When you install it, you get a
console script: sphinx-autogen, which is a direct link to
autosummary_generate.py's main() function.
Very interesting.
The big question is:
Do you want me to
To re-iterate, I did not want to fork the entire of sphinx, rather,
just the autosummary stuff that the folks from Numpy have created.
Let me know if/how you want me to integrate with the sphinx codebase,
and I will be happy to do so.
cheers.
-chris
On Oct 24, 4:33 am, Sebastien Douche [EMAIL
Hi,
Fri, 24 Oct 2008 08:47:17 -0700, percious wrote:
To re-iterate, I did not want to fork the entire of sphinx, rather, just
the autosummary stuff that the folks from Numpy have created. Let me
know if/how you want me to integrate with the sphinx codebase, and I
will be happy to do so.
I
, and
functions, classes, and exceptions within that module are now auto-
documented.
I had a hard time figuring out how to use autosummary, and since I
want to do a presentation at pycon about it, I'd like to have it be
really easy to use. I'd also rather see it being included in sphinx,
as apposed
Hey guys,
I am planning a talk for Pycon on sphinx, and I wanted to make it a
bit easier to use, because the amount of boiler plate you have to do
to document your modules is sort of obscene.
Anyway, I stumbled upon numpyext, which did most of what I wanted, but
lacked some polish.
I modified
71 matches
Mail list logo
