Issue #2828 resolved

Render reStructuredText in *.txt files. (BB-2043)

Stefan Scherfke
created an issue

Most Python packages are using reStructuredText to format e.g. their README files. According to the //Hitchhiker’s Guide to Packaging [1]//, README and other documentation files should have the *.txt extension.

It would be nice if Bitbucket would not only render .rst files as rst, but also .txt files. The Python Package Index does this already.

If an error occured while parsing .txt files, you could simply fall back to plain text. I don’t think this should be a problem since .rst files could also contain errors (so you should already handle them anyways).

If you are afraid that there will be a lot of errors for non-Python projects, you might activate this featere only for projects labeled as Python projects.


Comments (5)

  1. David Chambers

    I really like the idea of having this apply only to Python projects, since the majority of similar requests have come from other users keen to have READMEs rendered as HTML on both Bitbucket and PyPI.

  2. Brodie Rao

    Seems I forgot to update this ticket, but this was implemented recentlyish (a month or two ago, I think?). If you set your repository language to Python, we'll try to parse README.txt or README as reStructuredText.

  3. Log in to comment