[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by anatoly techtonik techto...@gmail.com: -- nosy: +techtonik ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Daniel Stutzbach stutzb...@google.com added the comment: On Tue, Dec 14, 2010 at 7:22 PM, Ezio Melotti rep...@bugs.python.org wrote: If you want to work on this you should also consider that the URLs used on docs.python.org don't necessary match the directory structure present when building the doc locally. For example here it would be: .../py3k/library/fractions.html .../release31-maint/library/fractions.html .../release27-maint/library/fractions.html .../release26-maint/library/fractions.html Will this directory structure change as part of the hg migration? -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Éric Araujo mer...@netwok.org added the comment: No, because with Subversion or Mercurial you’re free to clone/checkout any branch in a directory with an arbitrary name. For the py3k branch, Ezio’s checkout is named py3k but mine is 3.2, there is no way to put knowledge about that in the doc itself. -- nosy: +eric.araujo ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Michael Buckley newslett...@codefisher.org added the comment: You might want to check out what Django does, as they have the working well. http://docs.djangoproject.com/en/dev/ -- nosy: +codefisher ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by Daniel Stutzbach stutzb...@google.com: -- versions: -Python 3.2 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Ezio Melotti ezio.melo...@gmail.com added the comment: If you want to work on this you should also consider that the URLs used on docs.python.org don't necessary match the directory structure present when building the doc locally. For example here it would be: .../py3k/library/fractions.html .../release31-maint/library/fractions.html .../release27-maint/library/fractions.html .../release26-maint/library/fractions.html This could be addressed with a config file that is not kept under version control (and possibly with default values used when this file is not present). -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by Éric Araujo mer...@netwok.org: -- nosy: +d...@python ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Terry J. Reedy tjre...@udel.edu added the comment: The link does not currently work. I think this effectively impossible for volunteers. Microsoft has 1000s of paid employees. Chapter and Sections numbers do not match from version to version. How many other versions would you link to? Multiple links could get a bit ugly. What might be done is to put one permanent link to All doc versions on the sidebar. -- nosy: +tjreedy versions: -Python 2.6 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Ezio Melotti ezio.melo...@gmail.com added the comment: 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. -- status: open - pending ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Daniel Stutzbach dan...@stutzbachenterprises.com added the comment: On Sat, Jul 10, 2010 at 1:56 AM, Terry J. Reedy rep...@bugs.python.orgwrote: I think this effectively impossible for volunteers. Microsoft has 1000s of paid employees. Chapter and Sections numbers do not match from version to version. We don't need to match numbers, we just need to match links, which in 99% of all cases follow a regular pattern: For example: http://docs.python.org/py3k/library/fractions.html http://docs.python.org/library/fractions.html http://docs.python.org/release/2.6.5/library/fractions.html It's pretty easy to generate the links to the corresponding pages. The trickier part is testing that the link is valid when building the pages. In an ideal universe, there would be a way to manually specify when a page has been renamed (e.g., _winreg - winreg), but even if those links were missing it would still be quite useful (IMO, of course). How many other versions would you link to? Multiple links could get a bit ugly. The same number as currently listed in the sidebar on the index page. -- status: pending - open Added file: http://bugs.python.org/file17926/unnamed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___div class=gmail_quoteOn Sat, Jul 10, 2010 at 1:56 AM, Terry J. Reedy span dir=ltrlt;a href=mailto:rep...@bugs.python.org; target=_blankrep...@bugs.python.org/agt;/span wrote:brblockquote class=gmail_quote style=margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex I think this effectively impossible for volunteers. Microsoft has 1000s of paid employees. Chapter and Sections numbers do not match from version to version.br/blockquotedivbr/divdivWe don#39;t need to match numbers, we just need to match links, which in 99% of all cases follow a regular pattern:/div divbr/divdivFor example:/divdivbr/divdiva href=http://docs.python.org/py3k/library/fractions.html; target=_blankhttp://docs.python.org/py3k/library/fractions.html/a/divdiva href=http://docs.python.org/library/fractions.html; target=_blankhttp://docs.python.org/library/fractions.html/a/div diva href=http://docs.python.org/release/2.6.5/library/fractions.html; target=_blankhttp://docs.python.org/release/2.6.5/library/fractions.html/a/divdivbr/divdivIt#39;s pretty easy to generate the links to the corresponding pages. Â The trickier part is testing that the link is valid when building the pages./div divbr/divdivIn an ideal universe, there would be a way to manually specify when a page has been renamed (e.g., _winreg -gt; winreg), but even if those links were missing it would still be quite useful (IMO, of course)./div divbr/divblockquote class=gmail_quote style=margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex How many other versions would you link to? Multiple links could get a bit ugly.br/blockquotedivbr/divdivThe same number as currently listed in the sidebar on the index page./div/div ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Daniel Stutzbach dan...@stutzbachenterprises.com added the comment: On Sat, Jul 10, 2010 at 2:12 AM, Ezio Melotti rep...@bugs.python.orgwrote: 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: h3Docs 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 rep...@bugs.python.org http://bugs.python.org/issue8040 ___div class=gmail_quoteOn Sat, Jul 10, 2010 at 2:12 AM, Ezio Melotti span dir=ltrlt;a href=mailto:rep...@bugs.python.org;rep...@bugs.python.org/agt;/span wrote:brblockquote 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=_blankhttp://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./blockquotedivbr/divdivWhen 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 divbr/divdivIt would require a new Sphinx extension, but it need not be a complex one./divdivbr/divdivInside sidebartoc:/divbrlt;h3gt;Docs for other versionslt;/h3gt;brlt;ulgt;/divdiv class=gmail_quote (call extension module)/divdiv class=gmail_quotelt;/ulgt;/divdiv class=gmail_quotebr/divdiv class=gmail_quoteThe 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_quotebr/divdiv class=gmail_quoteIf 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 ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by Daniel Stutzbach dan...@stutzbachenterprises.com: Removed file: http://bugs.python.org/file17926/unnamed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by Daniel Stutzbach dan...@stutzbachenterprises.com: Removed file: http://bugs.python.org/file17927/unnamed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Terry J. Reedy tjre...@udel.edu added the comment: All yours. Good luck. As usual, no guarantees on acceptance of any particular patch. I am marking this for 3.2 because that is where new *code* will go and that is also the doc set you should experiment with. That is not to say that new code, once approved, cannot be applied to past doc sets. -- assignee: georg.brandl - stutzbach stage: - needs patch versions: -Python 2.7, Python 3.1 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
New submission from Daniel Stutzbach dan...@stutzbachenterprises.com: Currently, trying to use a web search engine to find something in the Python docs often returns the documentation for only one version of Python. Something a very old version like 2.3. It would be nice if the documentation pages on docs.python.org included links to older and later versions of the same documentation page, if one exists. That would make it much easier to navigate to the desired version of a page. The extra links could be placed on the sidebar on the left side, perhaps below the Quick Search box. Additionally, it might help search engines find and index the documentation for the other versions. Microsoft does this for their .NET documentation and it's very handy (e.g., http://msdn.microsoft.com/en-us/library/system.windows.forms.control.aspx) -- assignee: georg.brandl components: Documentation messages: 100297 nosy: georg.brandl, stutzbach severity: normal status: open title: It would be nice if documentation pages linked to other versions of the same document type: feature request ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Changes by Ezio Melotti ezio.melo...@gmail.com: -- nosy: +ezio.melotti priority: - normal versions: +Python 2.6, Python 2.7, Python 3.1, Python 3.2 ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue8040] It would be nice if documentation pages linked to other versions of the same document
Martin v. Löwis mar...@v.loewis.de added the comment: It think it's also extremely difficult to implement, since the switchover to a new documentation generator. Contributions are welcome. -- nosy: +loewis ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue8040 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
