classification
Title: use paths relative to CPython root in documentation building instructions
Type: Stage: patch review
Components: Devguide, Documentation Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: chris.jerdonek, docs@python, ezio.melotti, georg.brandl, python-dev, r.david.murray, sandro.tosi, tshepang
Priority: normal Keywords: patch

Created on 2012-12-29 14:05 by tshepang, last changed 2012-12-29 20:47 by tshepang. This issue is now closed.

Files
File name Uploaded Description Edit
use-paths-relative-to-root.diff tshepang, 2012-12-29 14:05
Messages (10)
msg178494 - (view) Author: Tshepang Lekhonkhobe (tshepang) * Date: 2012-12-29 14:05
I think it's a good idea to simply list the 'full' path.
msg178504 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2012-12-29 15:43
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.
msg178516 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2012-12-29 17:50
Fine with me.
msg178527 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-12-29 20:01
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
msg178528 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-12-29 20:07
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.
msg178529 - (view) Author: Sandro Tosi (sandro.tosi) * (Python committer) Date: 2012-12-29 20:12
> 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)."
msg178530 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-12-29 20:23
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.
msg178531 - (view) Author: Tshepang Lekhonkhobe (tshepang) * Date: 2012-12-29 20:26
The Linux (and Unix?) equivalent is xdg-open.
msg178532 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2012-12-29 20:41
FTR there's also "make htmlview" that already opens a browser to the index of the locally built docs.
msg178534 - (view) Author: Tshepang Lekhonkhobe (tshepang) * Date: 2012-12-29 20:47
Nice. Didn't know about that one.
History
Date User Action Args
2012-12-29 20:47:52tshepangsetmessages: + msg178534
2012-12-29 20:41:06ezio.melottisetmessages: + msg178532
2012-12-29 20:26:31tshepangsetmessages: + msg178531
2012-12-29 20:23:58chris.jerdoneksetmessages: + msg178530
2012-12-29 20:12:31sandro.tosisetnosy: + sandro.tosi
messages: + msg178529
2012-12-29 20:07:32chris.jerdoneksetstatus: open -> closed

nosy: + chris.jerdonek
messages: + msg178528

resolution: fixed
stage: patch review
2012-12-29 20:01:38python-devsetnosy: + python-dev
messages: + msg178527
2012-12-29 17:50:14georg.brandlsetmessages: + msg178516
2012-12-29 15:43:05r.david.murraysetnosy: + georg.brandl, r.david.murray

messages: + msg178504
title: use paths relative to CPython root -> use paths relative to CPython root in documentation building instructions
2012-12-29 14:05:58tshepangcreate