autosummary no longer links methods in the class to documentation

922 views
Skip to first unread message

Lisa Zorn

unread,
Aug 17, 2012, 3:29:16 PM8/17/12
to sphin...@googlegroups.com
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.



I have looked around for options and so forth that could have caused this but found nothing.  My conf.py and index.rst are in here: http://code.google.com/p/dta/source/browse/?name=dev#git%2Fdoc

Thank you for any assistance; I really need those links back because the pages are a hassle to use now.
-Lisa

Lisa Zorn

unread,
Oct 25, 2012, 4:02:04 PM10/25/12
to sphin...@googlegroups.com
Anyone?  This is so frustrating because I now build two sets of sphinx documentation with the same code (sphinx 1.1.3)
and similar conf.py files and one exhibits the problem and the other does not.  I have made sure the problem set has no errors
during documentation generation, I'm just not sure why one has the xref but the other one does not.
-Lisa

gilberto dos santos alves

unread,
Oct 29, 2012, 11:14:42 AM10/29/12
to sphin...@googlegroups.com
if i understand your issue, have you see this entire documentation more detailed information about 
"

sphinx-autogen – generate autodoc stub pages

The sphinx-autogen script can be used to conveniently generate stub documentation pages for items included in 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 sphinx versions? best regards

--
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/-/sdxnsdrr1PgJ.

To post to this group, send email to sphin...@googlegroups.com.
To unsubscribe from this group, send email to sphinx-dev+...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.



--
gilberto dos santos alves
+55.11.98646-5049
são paulo - sp - brasil





gilberto dos santos alves

unread,
Oct 29, 2012, 11:18:05 AM10/29/12
to sphin...@googlegroups.com
try force this in your conf.py to your 1.1.3 and see logs and results.
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

2012/10/29 gilberto dos santos alves <gsa...@gmail.com>

Lisa Zorn

unread,
Oct 29, 2012, 2:44:48 PM10/29/12
to sphin...@googlegroups.com
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 these settings, and automatically generate documentation for my python classes.  The problem that I am having is that the table list of methods in the automatically generated documentation does not have the "xref" links to the actual documentation below.  From my original post:



What I have been unable to figure out is why is the table not linking to the documentation?  I have also generated documentation for another project (so using the same version of sphinx) with very similar configuration and the links are there.  So something must have gone wrong with my documentation generation for this one project causing the links not to show up, but I have not been able to figure out what it is.
-Lisa

gilberto dos santos alves

unread,
Oct 29, 2012, 3:52:12 PM10/29/12
to sphin...@googlegroups.com
in this fragment of your new doc (line 126-134 of html source), i could see class=xref created, but with new visual enhanced row-even / odd for separators? what i miss, please?
fragment=>>begin
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">getNumAttachedConnectors</span></tt>()</td>
<td>Return the number of connectors attached to this Centroid.</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">getNumIncomingConnectors</span></tt>()</td>
<td>Return the number of incoming connectors.</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">getNumIncomingLinks</span></tt>()</td>
<td>Returns the number of incoming links.</td>
</tr>
fragment=>>end

2012/10/29 Lisa Zorn <lisa...@sfcta.org>
To view this discussion on the web visit https://groups.google.com/d/msg/sphinx-dev/-/B_WWI931AjQJ.

To post to this group, send email to sphin...@googlegroups.com.
To unsubscribe from this group, send email to sphinx-dev+...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Reply all
Reply to author
Forward
0 new messages