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.

Sign up for GitHub

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

Add devhelp build instructions to the documentation makefile #62584

Closed
brouberol mannequin opened this issue Jul 6, 2013 · 3 comments
Closed

Add devhelp build instructions to the documentation makefile #62584

brouberol mannequin opened this issue Jul 6, 2013 · 3 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@brouberol
Copy link
Mannequin

brouberol mannequin commented Jul 6, 2013

BPO 18384
Nosy @birkenfeld, @bitdancer, @berkerpeksag
Files
  • devhelp-build-py3.patch: Patch for python 3 only
  • devhelp-build-py2.patch: Patch for Python 2 only
    		•

    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 2016-06-02.02:55:07.353>
created_at = <Date 2013-07-06.16:07:52.952>
labels = ['type-feature', 'docs']
title = 'Add devhelp build instructions to the documentation makefile'
updated_at = <Date 2016-06-02.02:55:07.352>
user = 'https://bugs.python.org/brouberol'

    bugs.python.org fields:

    activity = <Date 2016-06-02.02:55:07.352>
actor = 'berker.peksag'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-06-02.02:55:07.353>
closer = 'berker.peksag'
components = ['Documentation']
creation = <Date 2013-07-06.16:07:52.952>
creator = 'brouberol'
dependencies = []
files = ['30824', '30826']
hgrepos = []
issue_num = 18384
keywords = ['patch']
message_count = 3.0
messages = ['192457', '192752', '266866']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'r.david.murray', 'docs@python', 'berker.peksag', 'brouberol']
pr_nums = []
priority = 'normal'
resolution = 'rejected'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18384'
versions = ['Python 2.7', 'Python 3.4']
    @brouberol
    Copy link
    Mannequin Author

    brouberol mannequin commented Jul 6, 2013

    The documentation makefile is missing support for Devhelp.

    The supplied patch fixes this for the Python 3 branch.
    It also edits the ouput of the sphinx build to change the name of the devhelp project.

    This is needed to be able to have both versions of documentation (py2 & py3) displayed in Devhelp. This is useful if developers need to access documentation for both versions, such as both maintaining a Python2 project and starting a new project in Python3.

    This has been patched in some distributions downstream, but would be nice to have patched upstream. See: https://bugs.launchpad.net/ubuntu/+source/devhelp/+bug/787039

    @brouberol brouberol mannequin assigned docspython Jul 6, 2013
    @brouberol brouberol mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jul 6, 2013
    @brouberol brouberol mannequin changed the title Add devhelp build instructions to the documentation makefile Add devhelp build instructions to the documentation makefile (Python3) Jul 6, 2013
    @brouberol brouberol mannequin changed the title Add devhelp build instructions to the documentation makefile (Python3) Add devhelp build instructions to the documentation makefile Jul 6, 2013
    @bitdancer
    Copy link
    Member

    I'm not sure that this belongs in core, but I'll certainly defer to Georg on that :). If it does go in, the help string should explain what 'devhelp' does, since it isn't obvious from the name (for a non-GNOME user...I had to google it).

    @berkerpeksag
    Copy link
    Member

    I think we should avoid adding distro specific tools into CPython repository (and the another reason to reject this is that the other distros will probably want to add their tools).

    @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 type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @berkerpeksag @bitdancer