Skip to content

reStructuredText (.rst) text files not displaying content #53

Closed

Description

There is a problem with reStructuredText files (.rst) not displaying in the code browser. reStructuredText is just a text format, I know it's not markdown but they are just plain text (like markdown) so the content should at least be displayed if it cant be rendered. Normally what happens is parts of the file are simply omitted. I think what really should happen, at the least, is that they are treated as normal text files with all the content shown.

I give an extreme example of what's happening: https://github.com/doctrine/orm-documentation/blob/master/en/index.rst
Notice file has 67 lines, but github's viewer just shows 7 lines.

For reference, reStructuredText - http://docutils.sourceforge.net/rst.html
Used by Sphinx document generator - http://sphinx.pocoo.org/

The reason OSS projects use .rst files is because it's more or less like Markdown but it can be used to generated structured documentation with TOC/Index/Search etc with zero extra cost. I'm not asking that you guys render it, but at least display the content in the repo viewer.

Activity

  1. shino commented on Aug 29, 2011

    @shino

    toctree directive is NOT the directive in reStructuredText specification.
    Sphinx defines the directive.

  2. tnm commented on Aug 4, 2012

    @tnm
    Contributor

    This should be fixed with our latest updates on docutils.

  3. alexfornuto commented on Jan 2, 2014

    @alexfornuto

    FWIW I'm having this issue currently with RST files not showing content listed with .. file:: directives. I know it's not a directive defined in the rst specs, but I would at least hope to see the raw information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions