Accommodate plaintext READMEs in Python repos (BB-2892)

David Chambers avatarDavid Chambers created an issue

For non-Python repositories, naming the file "README" or "README.txt" does the job, but for Python repos these are treated as reStructuredText. This forces users to remove the language selection or use a nonstandard file name in order to have a README treated as plaintext.

Comments (6)

  1. David Chambers

    Here's the story behind the special treatment of Python READMEs…

    PyPI assumes that a file named “README” or “README.txt” represents a reStructuredText README. For compatibility with PyPI, Bitbucket makes the same assumption. The downside of this, though, is that it's not possible to indicate that a plaintext README in a Python repo should be treated as such.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.