README.rst :include: directive doesn't work

[jaredly]

The :include: restructuredtext directive (http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment) looks like it's disabled at the moment. https://github.com/github/markup/blob/master/lib/github/commands/rest2html#L24

Could you enable it, so that I could, for example, put

.. include:: requirements.txt
   :literal:

And it would put the contents of the requirements.txt file into the rendered readme page.

[jm]

I doubt this will ever be re-enabled for security reasons, but I will let someone else make that final call. :)

[jaredly]

hmmm so would there need to be a change to docutils to allow restrictions? for example -- only include documents in the current directory or lower?

[TimidRobot]

It would be very helpful to be able to include LICENSE, requirements.txt, etc.

[hit9]

I also meet the same problem to include codes from sample/codes to my readme.rst. I think this feature will be very helpful

[thomas-scrace]

I also think this would be a very useful feature. For example, it is convenient to store a DESCRIPTION.rst file in repositories that use python's distutils so that it can be read into setup.py as the long_description argument. But of course, the description also wants to be in README.rst, so at the moment one is forced to duplicate the same material in two places, which is annoying.

[ncalexan]

Seconding what @jabapyth suggested: include only files in the current directory or lower. I just reworked my project's documentation to include the relevant pieces, only to find it doesn't show up at all. Thanks for that, @github. Some indication such as links to included files or even just a mention that pieces are missing would go a long way.

[gvangool]

Enabling it for other .rst files would also help (in my case)

[itsjohncs]

I would also like to see this implemented. I'd like to include code examples in my README without having to copy and paste them or include my README in my build system.

[mojavelinux]

We have the same limitation in AsciiDoc files. I'd like to see a unified way to provide an include hook in markup so that GitHub can handle the intent to include the file as they see fit. Surely it's okay to combine files, they would just like to be able to load them in dedicated code for reasons of security, caching and other such reasons. Can we discuss this possibility?

[kaystrobach]

any news on that?

[Seraf]

Hello, same problem here. I would like to use include to avoid duplicating information (and forget to update it somewhere)

[artob]

Just encountered this problem myself. It seems that for the time being content just has to be duplicated verbatim into the README file, which is pretty unfortunate and not very maintainable in the long run.

[kaystrobach]

but you can link documents :D -> this way you can store the docs in documentation and link to the rst from the readme :D

[fgmacedo]

any news on that? +1