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

Reorganize pip's docs folder #5724

Merged
merged 2 commits into from
Aug 24, 2018
Merged

Conversation

pradyunsg
Copy link
Member

This breaks up pip's docs folder into 2 folders: html/ and man/. They hold exactly what you expect them to.

It ensures that when HTML output is generated, it doesn't include man pages: https://pip.pypa.io/en/stable/man/pip/. (this has been the case since they were added and it's not-nice)


The conf.py file is updated to make the required changes and stays in the same directory, while the sources move. This requires passing -c to sphinx-build, so I'll check if RTD would be happy about it.

@pradyunsg pradyunsg added the type: docs Documentation related label Aug 22, 2018
@pradyunsg pradyunsg added this to the Internal Cleansing milestone Aug 22, 2018
@pradyunsg pradyunsg added the skip news Does not need a NEWS file entry (eg: trivial changes) label Aug 22, 2018
Also add a small comment explaining why this has been done.
@pradyunsg
Copy link
Member Author

This requires one change to RTD:

screen shot 2018-08-23 at 10 43 42 am

@pradyunsg
Copy link
Member Author

Before this PR:

docs
├── __init__.py
├── conf.py
├── [html docs sources]
├── pipext.py
└── man
   └── [man pages sources]

After this PR:

docs
├── html
│   ├── conf.py
|   └── [html docs sources]
├── man
|   └── [man pages sources]
└── pip_sphinxext.py

@pradyunsg
Copy link
Member Author

@pypa/pip-committers I'm willing to go ahead and merge this -- any thoughts?

@pradyunsg pradyunsg merged commit 404838a into pypa:master Aug 24, 2018
@pradyunsg pradyunsg deleted the docs/reorganize branch August 24, 2018 13:58
@pradyunsg
Copy link
Member Author

I've gone ahead and merged this since I doubt anyone would really mind this change. I'll be happy to make additional changes in follow up PRs. :)

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Jun 24, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Jun 24, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation 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.

1 participant