Uploaded image for project: 'Bitbucket Cloud'
  1. Bitbucket Cloud
  2. BCLOUD-2828

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

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      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.

      [1] http://guide.python-distribute.org/creation.html

      Attachments

        Activity

          People

            93e1e5ba154a aiiie
            df3aee360666 sscherfke
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: