[issue8040] It would be nice if documentation pages linked to other versions of the same document

[Daniel Stutzbach]

Daniel Stutzbach <daniel at stutzbachenterprises.com> added the comment:

On Sat, Jul 10, 2010 at 2:12 AM, Ezio Melotti <report at bugs.python.org>wrote:

> I think I've already discussed this with Georg a while ago and we ended up
> adding the links on the left sidebar in http://docs.python.org/.
> IIRC there's no easy way to find the same document in another version of
> the doc, not even now with Sphinx.
> I think this can be closed, unless Georg disagrees.

When I opened this issue originally, I hadn't learned Sphinx yet and
couldn't propose a solution.  Since then I've started using Sphinx and have
a much better idea of what it can and cannot do.

It would require a new Sphinx extension, but it need not be a complex one.

Inside sidebartoc:

<h3>Docs for other versions</h3>
<ul>
(call extension module)
</ul>

The extension module would use a global directory (outside of a particular
version's Sphinx build) to keep track of which versions had generated the
same page.  The builds would have to be run twice, once to produce all of
the information and once to include it.  Alternately, they could be run once
if it's acceptable to use Apache Server-Side-Includes (SSI).

If you want to assign the issue to me and leave it open, that would be fine
with me.  I can't promise to get to it soon, but I'm willing to work on it
eventually.

----------
Added file: http://bugs.python.org/file17927/unnamed

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue8040>
_______________________________________
-------------- next part --------------
<div class="gmail_quote">On Sat, Jul 10, 2010 at 2:12 AM, Ezio Melotti <span dir="ltr">&lt;<a href="mailto:report at bugs.python.org">report at bugs.python.org</a>&gt;</span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
I think I&#39;ve already discussed this with Georg a while ago and we ended up adding the links on the left sidebar in <a href="http://docs.python.org/" target="_blank">http://docs.python.org/</a>.<br>
IIRC there&#39;s no easy way to find the same document in another version of the doc, not even now with Sphinx.<br>
I think this can be closed, unless Georg disagrees.</blockquote><div><br></div><div>When I opened this issue originally, I hadn&#39;t learned Sphinx yet and couldn&#39;t propose a solution. Â Since then I&#39;ve started using Sphinx and have a much better idea of what it can and cannot do.</div>
<div><br></div><div>It would require a new Sphinx extension, but it need not be a complex one.</div><div><br></div><div>Inside sidebartoc:</div><br>&lt;h3&gt;Docs for other versions&lt;/h3&gt;<br>&lt;ul&gt;</div><div class="gmail_quote">
(call extension module)</div><div class="gmail_quote">&lt;/ul&gt;</div><div class="gmail_quote"><br></div><div class="gmail_quote">The extension module would use a global directory (outside of a particular version&#39;s Sphinx build) to keep track of which versions had generated the same page.  The builds would have to be run twice, once to produce all of the information and once to include it.  Alternately, they could be run once if it&#39;s acceptable to use Apache Server-Side-Includes (SSI).</div>
<div class="gmail_quote"><br></div><div class="gmail_quote">If you want to assign the issue to me and leave it open, that would be fine with me. Â I can&#39;t promise to get to it soon, but I&#39;m willing to work on it eventually.</div>