Skip to content

In ./Doc, "make html" and "make build" should depend on "make venv" #88919

Closed
Closed
In ./Doc, "make html" and "make build" should depend on "make venv"#88919
Labels
3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirrelease-blockertype-featureA feature request or enhancement

Description

@jdevries3133
jdevries3133
mannequin
opened on Jul 28, 2021
BPO 44756
Nosy @ned-deily, @encukou, @ambv, @hroncok, @pablogsal, @miss-islington, @jdevries3133
PRs
  • bpo-44756: in ./Doc, make build depends on make html #27403
  • [3.10] bpo-44756: in ./Doc, make build depends on make html (GH-27403) #27410
  • [3.9] bpo-44756: in ./Doc, make build depends on make html (GH-27403) #27411
  • bpo-44756: [docs] revert automated virtual environment creation on make html #27635
  • [3.9] bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635) #27636
  • [3.10] bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635) #27637
  • bpo-44756: Remove misleading NEWS entries of a change that was reverted before release #28075
    		•

    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 2021-08-06.19:53:19.845>
created_at = <Date 2021-07-28.04:47:25.985>
labels = ['3.9', '3.10', '3.11', 'type-feature', 'release-blocker', 'docs']
title = 'In ./Doc, "make html" and "make build" should depend on "make venv"'
updated_at = <Date 2021-08-30.21:56:40.474>
user = 'https://github.com/jdevries3133'

    bugs.python.org fields:

    activity = <Date 2021-08-30.21:56:40.474>
actor = 'lukasz.langa'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-08-06.19:53:19.845>
closer = 'lukasz.langa'
components = ['Demos and Tools', 'Documentation']
creation = <Date 2021-07-28.04:47:25.985>
creator = 'jack__d'
dependencies = []
files = []
hgrepos = []
issue_num = 44756
keywords = ['patch']
message_count = 19.0
messages = ['398344', '398373', '398381', '398383', '398384', '398827', '398840', '398848', '398868', '398874', '398875', '398884', '399101', '399116', '399124', '399130', '399135', '400672', '400673']
nosy_count = 8.0
nosy_names = ['ned.deily', 'petr.viktorin', 'docs@python', 'lukasz.langa', 'hroncok', 'pablogsal', 'miss-islington', 'jack__d']
pr_nums = ['27403', '27410', '27411', '27635', '27636', '27637', '28075']
priority = 'release blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue44756'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

    Activity

    1. jdevries3133 commented on Jul 28, 2021

      @jdevries3133
      jdevries3133mannequin
      on Jul 28, 2021
      MannequinAuthor

      In Doc/Makefile, all of the build rules should be dependent on the existence of a virtual environment. I could see this being controversial, because folks who have these tools installed elsewhere might prefer not to have a venv made for them, but my personal workflow is to strive to keep my system site-packages folder as empty as possible and to use virtual environments frequently. In any case, I'm interested to hear what we think.

      Momentarily, I will attach a PR where I went ahead and made these changes. Here is a summary of the changes:

      • venv rule is now conditional, and only does anything if $VENVDIR does
        not exist
      • add rule "clean-venv". This can be removed – what do you all think?
      • build rule is dependent on venv
      • as a result, rules dependent on build are dependent on venv
        • html
        • latex
        • etc.
      • update Doc/README.rst appropriately. Now users only need to type
        make html – nice!

      Let me know what you think. I may have a blind spot to others' workflows! Also, I'm not a Windows user, so I have no insight as to whether make.bat needs to be updated as well.

    2. jdevries3133
      added
      3.11only security fixes
      on Jul 28, 2021
    3. jdevries3133
      assigned
      docspython
      on Jul 28, 2021
    4. jdevries3133
      added
      docsDocumentation in the Doc dir
      type-featureA feature request or enhancement
      3.11only security fixes
      on Jul 28, 2021
    5. jdevries3133
      assigned
      docspython
      on Jul 28, 2021
    6. jdevries3133
      added
      docsDocumentation in the Doc dir
      type-featureA feature request or enhancement
      on Jul 28, 2021

    7. ambv commented on Jul 28, 2021

      @ambv
      ambv
      on Jul 28, 2021
      Contributor

      New changeset d22c876 by Jack DeVries in branch 'main':
      bpo-44756: in ./Doc, make build depends on make html (bpo-27403)
      d22c876

    8. ambv commented on Jul 28, 2021

      @ambv
      ambv
      on Jul 28, 2021
      Contributor

      New changeset f113195 by Miss Islington (bot) in branch '3.10':
      bpo-44756: in ./Doc, make build depends on make html (GH-27403) (GH-27410)
      f113195

    9. ambv commented on Jul 28, 2021

      @ambv
      ambv
      on Jul 28, 2021
      Contributor

      New changeset fd2c246 by Miss Islington (bot) in branch '3.9':
      bpo-44756: in ./Doc, make build depends on make html (GH-27403) (GH-27411)
      fd2c246

    10. ambv commented on Jul 28, 2021

      @ambv
      ambv
      on Jul 28, 2021
      Contributor

      Thanks, Jack! ✨ 🍰 ✨

    11. ambv
      closed this as completedon Jul 28, 2021
    12. ambv
      closed this as completedon Jul 28, 2021

    13. 10 remaining items

    14. ned-deily
      reopened this on Aug 6, 2021
    15. ned-deily
      added
      release-blocker
      3.9 (EOL)end of life
      3.10 (EOL)end of life
      on Aug 6, 2021

    16. ambv commented on Aug 6, 2021

      @ambv
      ambv
      on Aug 6, 2021
      Contributor

      New changeset 55fa87b by Łukasz Langa in branch 'main':
      bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635)
      55fa87b

    17. ambv commented on Aug 6, 2021

      @ambv
      ambv
      on Aug 6, 2021
      Contributor

      New changeset 91f6d38 by Miss Islington (bot) in branch '3.9':
      bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635) (GH-27636)
      91f6d38

    18. miss-islington commented on Aug 6, 2021

      @miss-islington
      miss-islington
      on Aug 6, 2021
      Contributor

      New changeset 1e9c9ca by Miss Islington (bot) in branch '3.10':
      bpo-44756: [docs] revert automated virtual environment creation on make html (GH-27635)
      1e9c9ca

    19. ambv commented on Aug 6, 2021

      @ambv
      ambv
      on Aug 6, 2021
      Contributor

      Revert done. Re-closing!

    20. ambv
      closed this as completedon Aug 6, 2021
    21. ambv
      closed this as completedon Aug 6, 2021

    22. ambv commented on Aug 30, 2021

      @ambv
      ambv
      on Aug 30, 2021
      Contributor

      New changeset 5246dbc by Łukasz Langa in branch 'main':
      bpo-44756: Remove misleading NEWS entries of a change that was reverted before release (GH-28075)
      5246dbc

    23. ambv commented on Aug 30, 2021

      @ambv
      ambv
      on Aug 30, 2021
      Contributor

      New changeset 9ef1843 by Łukasz Langa in branch '3.9':
      bpo-44756: Remove misleading NEWS entries of a change that was reverted before release (GH-28075)
      9ef1843

    24. ezio-melotti
      transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    No one assigned

      Labels

      3.10 (EOL)end of life3.11only security fixes3.9 (EOL)end of lifedocsDocumentation in the Doc dirrelease-blockertype-featureA feature request or enhancement

      Projects

      No projects

        Milestone

        No milestone

        Relationships

        None yet

        Development

        No branches or pull requests

        Issue actions