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

Add a dedicated page for "Requirements File Format" #10450

Merged
merged 4 commits into from Sep 17, 2021

Conversation

pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Sep 8, 2021

Toward #9475.

For reviewers, here's an easy rendered link to the newly added page: https://pip--10450.org.readthedocs.build/en/10450/reference/requirements-file-format/

This was originally the reference to the command line interface for pip.
That is now handled by cli/ pages, which frees up these pages for
describing other aspects of pip.
@pradyunsg pradyunsg added type: docs Documentation related skip news Does not need a NEWS file entry (eg: trivial changes) labels Sep 8, 2021
@pradyunsg pradyunsg force-pushed the docs/requirements-format branch 3 times, most recently from 9ea1e03 to 8b14140 Compare September 8, 2021 07:43
This is a better, more visible location for this file format. It is more
discoverable and more likely to show up in search results.
This is basically based on a wild guess, that the search engines would
rank this higher in searches about requirements.txt files, if we mention
the file explicitly here.
Co-authored-by: Paul Moore <p.f.moore@gmail.com>
@pradyunsg
Copy link
Member Author

Going to go ahead and merge this, similar to all the other documentation updates. As usual, feedback is welcome and if you have concerns, please voice them in #9475! :)

@pradyunsg pradyunsg merged commit 89326c8 into pypa:main Sep 17, 2021
@pradyunsg pradyunsg deleted the docs/requirements-format branch September 17, 2021 15:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants