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

docs: Updated Architecture anatomy.rst #10774

Merged
merged 4 commits into from
Apr 7, 2022
Merged

docs: Updated Architecture anatomy.rst #10774

merged 4 commits into from
Apr 7, 2022

Conversation

gavindsouza
Copy link
Contributor

  • Updated root directory structure
    • Nox usages
    • Removed folders/files that don't exist anymore
  • Updated src directory structure

Ref: #6831

Was just scrolling through some docs and realized hey tox.ini doesn't exist :thonk:
Anyway, fixed as much as I could verify. Don't think this requires a news entry.

@gavindsouza
docs: Updated Pip Anatomy
7b28428 
* Updated root directory structure
   * Nox usages
   * Removed folders/files that don't exist anymore
* Updated src directory structure
DiddiLeija
DiddiLeija reviewed Jan 15, 2022
View reviewed changes
Copy link
Member

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just another note below about the noxfile.py description.

docs/html/development/architecture/anatomy.rst Outdated Show resolved Hide resolved
@DiddiLeija
Copy link
Member

Also, please add a news entry for this PR. See https://pip.pypa.io/en/stable/development/contributing/#news-entries for more information.

@gavindsouza
Copy link
Contributor Author

@DiddiLeija The docs weren't clear on this. Thought only non trivial changes required a news entry. Also, the docs you specified implied news/{pr_number}.doc.rst for a docs change but news/{pr_number}.trivial.rst being used (via https://github.com/pypa/pip/tree/main/news).

I'm adding a trivial one for now. lmk if this needs to be changed.

@gavindsouza
Copy link
Contributor Author

Pushed another change to remedy the failing CI/docs build. Running nox -s docs locally gave me more errors like "/pip/docs/html/development/architecture/command-line-interface.rst:15:hardcoded link 'https://github.com/pypa/pip/issues/6831' could be replaced by an extlink". What can I do about those?

@gavindsouza gavindsouza requested a review from pradyunsg April 7, 2022 07:37
@pradyunsg pradyunsg closed this Apr 7, 2022
@pradyunsg pradyunsg reopened this Apr 7, 2022
@pradyunsg
Copy link
Member

Close-reopened to re-trigger CI.

@uranusjr uranusjr merged commit 182bac1 into pypa:main Apr 7, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@DiddiLeija DiddiLeija DiddiLeija left review comments

@pradyunsg pradyunsg pradyunsg approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@gavindsouza @DiddiLeija @pradyunsg @uranusjr