[issue16813] use paths relative to CPython root
New submission from Tshepang Lekhonkhobe: I think it's a good idea to simply list the 'full' path. ---------- assignee: docs@python components: Devguide, Documentation files: use-paths-relative-to-root.diff keywords: patch messages: 178494 nosy: docs@python, ezio.melotti, tshepang priority: normal severity: normal status: open title: use paths relative to CPython root Added file: http://bugs.python.org/file28479/use-paths-relative-to-root.diff _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
R. David Murray added the comment: Thanks for the suggestion, but the context is that you are in the Doc directory in order to run make, so I think the existing documentation is preferable. I'd let George decide, though. ---------- nosy: +georg.brandl, r.david.murray title: use paths relative to CPython root -> use paths relative to CPython root in documentation building instructions _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Georg Brandl added the comment: Fine with me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Roundup Robot added the comment: New changeset 20333d160f4e by Chris Jerdonek in branch 'default': Issue #16813: Use the full relative path in the documentation-building instructions. http://hg.python.org/devguide/rev/20333d160f4e ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Chris Jerdonek added the comment: Thanks for the patch. Out of curiosity, does anyone know if the following works on all or most systems? $ open _build/html/index.html That could also be added to save time for people that don't already know. ---------- nosy: +chris.jerdonek resolution: -> fixed stage: -> patch review status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Sandro Tosi added the comment:
Out of curiosity, does anyone know if the following works on all or most systems?
$ open _build/html/index.html
it doesn't work on my Debian system: $ open _build/html/index.html Couldn't get a file descriptor referring to the console as open is a link to "openvt - start a program on a new virtual terminal (VT)." ---------- nosy: +sandro.tosi _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Chris Jerdonek added the comment: Thanks. Btw, it works for me on Mac OS X I believe out of the box: Help: Open opens files from a shell. By default, opens each file using the default application for that file. If the file is in the form of a URL, the file will be opened as a URL. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Tshepang Lekhonkhobe added the comment: The Linux (and Unix?) equivalent is xdg-open. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Ezio Melotti added the comment: FTR there's also "make htmlview" that already opens a browser to the index of the locally built docs. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Tshepang Lekhonkhobe added the comment: Nice. Didn't know about that one. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
R. David Murray added the comment: Thanks for the suggestion, but the context is that you are in the Doc directory in order to run make, so I think the existing documentation is preferable. I'd let George decide, though. ---------- nosy: +georg.brandl, r.david.murray title: use paths relative to CPython root -> use paths relative to CPython root in documentation building instructions _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Georg Brandl added the comment: Fine with me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Roundup Robot added the comment: New changeset 20333d160f4e by Chris Jerdonek in branch 'default': Issue #16813: Use the full relative path in the documentation-building instructions. http://hg.python.org/devguide/rev/20333d160f4e ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Chris Jerdonek added the comment: Thanks for the patch. Out of curiosity, does anyone know if the following works on all or most systems? $ open _build/html/index.html That could also be added to save time for people that don't already know. ---------- nosy: +chris.jerdonek resolution: -> fixed stage: -> patch review status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Sandro Tosi added the comment:
Out of curiosity, does anyone know if the following works on all or most systems?
$ open _build/html/index.html
it doesn't work on my Debian system: $ open _build/html/index.html Couldn't get a file descriptor referring to the console as open is a link to "openvt - start a program on a new virtual terminal (VT)." ---------- nosy: +sandro.tosi _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Chris Jerdonek added the comment: Thanks. Btw, it works for me on Mac OS X I believe out of the box: Help: Open opens files from a shell. By default, opens each file using the default application for that file. If the file is in the form of a URL, the file will be opened as a URL. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Tshepang Lekhonkhobe added the comment: The Linux (and Unix?) equivalent is xdg-open. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Ezio Melotti added the comment: FTR there's also "make htmlview" that already opens a browser to the index of the locally built docs. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
Tshepang Lekhonkhobe added the comment: Nice. Didn't know about that one. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue16813> _______________________________________
participants (7)
-
Chris Jerdonek -
Ezio Melotti
-
Georg Brandl
-
R. David Murray
-
Roundup Robot
-
Sandro Tosi
-
Tshepang Lekhonkhobe