Ok, well if that means the docstrings don't make it into the html docs, I think we need to figure out another solution. Is it possible to include the toctree entries but on one monolithic page or a few pages covering different API categories?
-Nathan
On 7/15/12 8:48 PM, Matthew Turk wrote:
Hi Nathan,
I can't remember if the current development tip does this or not, but one idea that had been floated was removing toctree entries for auto-generated docs. This was to experiment with how search functions. It's likely that if toctree entries aren't emitted by the API docs, they won't be available for cross-linking.
-Matt
On Sun, Jul 15, 2012 at 8:46 PM, Nathan Goldbaum nathan12343@gmail.com wrote:
Sorry for not being clearer. It's that there are dead links scattered throughout the docs.
I've placed a build of the docs at http://ucolick.org/~goldbaum/files/build/html/
If you compare this page: http://ucolick.org/~goldbaum/files/build/html/analyzing/objects.html
to the equivalent in the current version of the docs: http://yt-project.org/doc/analyzing/objects.html
You'll see that links to api entries don't work. In the 2.3 docs the api entries pointed to a page like this:
http://yt-project.org/doc/reference/api/generated/yt.data_objects.data_conta...
On 7/15/12 8:33 PM, Matthew Turk wrote:
Hi Nathan,
Not sure I understand -- is the link to the API docs not going? Is api.rst not being built? Are there links to things in the docs scattered about that are dead?
-Matt
On Sun, Jul 15, 2012 at 7:24 PM, Nathan Goldbaum nathan12343@gmail.com wrote:
Hi all,
It seems that the recent changes to the docs have broken the internal links to api references. Since the docstrings are inside the api references, this means the docstrings don't show up in new builds of the docs. I'm not sure if this is a sphinx issue or an issue with the tip of yt-doc.
I think there was some discussion about consolidating the api reference pages, which I am in favor of, but we should still make sure the docstrings are available inside the html docs.
Nathan _______________________________________________ yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org
yt-dev mailing list yt-dev@lists.spacepope.org http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org