This repository was archived by the owner on Nov 17, 2023. It is now read-only.
Remove pip overwrites #12604
Merged
Remove pip overwrites #12604
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your contribution @aaronmarkham |
szha
approved these changes
Sep 20, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR removes the overwriting of pip install instructions on the website. When we make updates to source to have the correct info, this script will overwrite it based on some dated logic. Now that we have consolidated install info, it doesn't make sense to have this injection happen. Also, the injection was a nuisance anyway since it would be so hard to track down. No one ever sees it happen in local dev builds of the docs.
This also resolves point 1.3 in the recent feedback thread about MXNet.
https://lists.apache.org/thread.html/fe2e883b2daf06e03283e4f3fcb3312c811a6e4cef8dbf1768ec29eb@%3Cdev.mxnet.apache.org%3E
This script was taking instructions that were correct in the source of the page and making them incorrect when the site was being published. (by add --pre)
The script also swaps out links to the examples based on your current version... which doesn't make a lot of sense because the example may not have existed for the version of the site that you're on. I guess it made sense if you were time-traveling through the site versions... maybe. Anyway, that's deleted by this PR too.
Comments
Generally, I would say that these kind of magical injections that happen at web publishing time are a bad idea because it makes the developer go crazy. They put in a link in their source, and then it gets magically butchered by an invisible script well after their code was merged. I hope to eventually get rid of this entire script once the versions dropdown is better integrated with the API docs.