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

migrate README to markdown #7565

Merged
merged 5 commits into from
May 9, 2023
Merged

migrate README to markdown #7565

merged 5 commits into from
May 9, 2023

Conversation

pmeier
Copy link
Collaborator

@pmeier pmeier commented May 8, 2023

It always bugged me that we had our README in rst rather than in markdown. This usually is only done in case we need to pull this into our sphinx documentation. But this is not the case here. Thus, I've aligned the README with all of our other files and migrated it to markdown.

This PR is a 1-to-1 port except for two changes:

  1. I've marked all headers below the first one as H2 rather than H1, which is usually reserved for the title.
  2. I've added a collapsible section to our compatibility table, since it has grown pretty large.

Rendered README.md

@pmeier pmeier added the other if you have no clue or if you will manually handle the PR in the release notes label May 8, 2023
@pmeier pmeier requested a review from NicolasHug May 8, 2023 19:53
@pytorch-bot
Copy link

pytorch-bot bot commented May 8, 2023

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/7565

Note: Links to docs will display an error until the docs builds have been completed.

❌ 1 New Failure, 1 Pending

As of commit 52dd3af:

NEW FAILURE - The following job has failed:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

Copy link
Member

@NicolasHug NicolasHug left a comment

Choose a reason for hiding this comment

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

I think the reason this is a rst file comes from the good old days when PyPI didn't support markdown (and IIRC GitHub didn't support rst for README. Good times).

Anyway, IMHO this is a very marginal improvement but I don't have a strong opinion so I'll approve to unblock. FYI, the collapsed table is formatted as "raw" - not sure if this is intended.

image

@pmeier
Copy link
Collaborator Author

pmeier commented May 9, 2023

FYI, the collapsed table is formatted as "raw" - not sure if this is intended.

Nope, not intended.

setup.py Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pmeier pmeier merged commit b1333dd into pytorch:main May 9, 2023
@pmeier pmeier deleted the readme-md branch May 9, 2023 12:39
@github-actions
Copy link

github-actions bot commented May 9, 2023

Hey @pmeier!

You merged this PR, but no labels were added. The list of valid labels is available at https://github.com/pytorch/vision/blob/main/.github/process_commit.py

facebook-github-bot pushed a commit that referenced this pull request May 15, 2023
Reviewed By: vmoens

Differential Revision: D45694878

fbshipit-source-id: d3fa448ee30adeb884ae38cc65cca72fcd96a3f1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla signed other if you have no clue or if you will manually handle the PR in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants