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

Update documentation building to use venv and pip #66588

Closed
brettcannon opened this issue Sep 12, 2014 · 5 comments
Closed

Update documentation building to use venv and pip #66588

brettcannon opened this issue Sep 12, 2014 · 5 comments
Assignees
@brettcannon
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@brettcannon
Copy link
Member

BPO 22394
Nosy @brettcannon, @birkenfeld
Files
  • doc_venv.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 = 'https://github.com/brettcannon'
closed_at = <Date 2014-12-05.20:18:01.210>
created_at = <Date 2014-09-12.14:37:26.870>
labels = ['type-feature', 'docs']
title = 'Update documentation building to use venv and pip'
updated_at = <Date 2014-12-05.20:18:01.209>
user = 'https://github.com/brettcannon'

    bugs.python.org fields:

    activity = <Date 2014-12-05.20:18:01.209>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2014-12-05.20:18:01.210>
closer = 'brett.cannon'
components = ['Documentation']
creation = <Date 2014-09-12.14:37:26.870>
creator = 'brett.cannon'
dependencies = []
files = ['37307']
hgrepos = []
issue_num = 22394
keywords = ['patch']
message_count = 5.0
messages = ['226821', '231484', '231820', '231822', '232206']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'georg.brandl', 'docs@python', 'tshepang', 'python-dev']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22394'
versions = ['Python 3.5']
    @brettcannon
    Copy link
    Member Author

    Now that we have ensurepip, is there any reason to not have the Doc/ Makefile create a venv for building the docs instead of requiring people to install sphinx into either their global Python interpreter or some venv outside of their checkout? Basically it would be like going back to the old Makefile of checking out the code but instead do a better isolation job and let pip manage fetching everything, updating the projects, etc.

    @brettcannon brettcannon added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Sep 12, 2014
    @brettcannon
    Copy link
    Member Author

    I'm going to at least update the Makefile to have a make venv that will do the steps necessary to create a venv and then check out the necessary tools. It should also be set up so that running the command with a pre-existing venv will update it. This should all lead to commands like make html PYTHON=venv/bin/python3 to work.

    @brettcannon
    Copy link
    Member Author

    Attached is a patch against Doc/Makefile to add a venv command to create a venv that can be used to build the documentation. Georg, can you give me an LGTM so I can commit this?

    @birkenfeld
    Copy link
    Member

    Sure. (The PyPI name is uppercased, but I guess it doesn't matter.)

    @brettcannon brettcannon assigned brettcannon and unassigned birkenfeld Dec 5, 2014
    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Dec 5, 2014

    New changeset 888103600e72 by Brett Cannon in branch 'default':
    Issue bpo-22394: Add a 'venv' command to Doc/Makefile.
    https://hg.python.org/cpython/rev/888103600e72

    @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

    @brettcannon brettcannon

    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
    @brettcannon @birkenfeld