Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use paths relative to CPython root in documentation building instructions #61017

Closed
tshepang mannequin opened this issue Dec 29, 2012 · 10 comments
Closed

use paths relative to CPython root in documentation building instructions #61017

tshepang mannequin opened this issue Dec 29, 2012 · 10 comments
Labels
docs Documentation in the Doc dir

Comments

@tshepang
Copy link
Mannequin

tshepang mannequin commented Dec 29, 2012

BPO 16813
Nosy @birkenfeld, @ezio-melotti, @bitdancer, @sandrotosi, @cjerdonek
Files
  • use-paths-relative-to-root.diff
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2012-12-29.20:07:32.081>
created_at = <Date 2012-12-29.14:05:58.525>
labels = ['docs']
title = 'use paths relative to CPython root in documentation building instructions'
updated_at = <Date 2012-12-29.20:47:52.978>
user = 'https://bugs.python.org/tshepang'

    bugs.python.org fields:

    activity = <Date 2012-12-29.20:47:52.978>
actor = 'tshepang'
assignee = 'docs@python'
closed = True
closed_date = <Date 2012-12-29.20:07:32.081>
closer = 'chris.jerdonek'
components = ['Documentation', 'Devguide']
creation = <Date 2012-12-29.14:05:58.525>
creator = 'tshepang'
dependencies = []
files = ['28479']
hgrepos = []
issue_num = 16813
keywords = ['patch']
message_count = 10.0
messages = ['178494', '178504', '178516', '178527', '178528', '178529', '178530', '178531', '178532', '178534']
nosy_count = 8.0
nosy_names = ['georg.brandl', 'ezio.melotti', 'r.david.murray', 'sandro.tosi', 'chris.jerdonek', 'docs@python', 'tshepang', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'patch review'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue16813'
versions = []
    @tshepang
    Copy link
    Mannequin Author

    tshepang mannequin commented Dec 29, 2012

    I think it's a good idea to simply list the 'full' path.

    @tshepang tshepang mannequin assigned docspython Dec 29, 2012
    @tshepang tshepang mannequin added docs Documentation in the Doc dir labels Dec 29, 2012
    @bitdancer
    Copy link
    Member

    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.

    @bitdancer bitdancer changed the title use paths relative to CPython root use paths relative to CPython root in documentation building instructions Dec 29, 2012
    @birkenfeld
    Copy link
    Member

    Fine with me.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Dec 29, 2012

    New changeset 20333d160f4e by Chris Jerdonek in branch 'default':
    Issue bpo-16813: Use the full relative path in the documentation-building instructions.
    http://hg.python.org/devguide/rev/20333d160f4e

    @cjerdonek
    Copy link
    Member

    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.

    @sandrotosi
    Copy link
    Contributor

    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)."

    @cjerdonek
    Copy link
    Member

    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.

    @tshepang
    Copy link
    Mannequin Author

    tshepang mannequin commented Dec 29, 2012

    The Linux (and Unix?) equivalent is xdg-open.

    @ezio-melotti
    Copy link
    Member

    FTR there's also "make htmlview" that already opens a browser to the index of the locally built docs.

    @tshepang
    Copy link
    Mannequin Author

    tshepang mannequin commented Dec 29, 2012

    Nice. Didn't know about that one.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @birkenfeld @sandrotosi @cjerdonek @bitdancer @ezio-melotti