Search code examples
githubpypitranscrypt

Include license file in readme

I have a file README.rst that I use both for PyPi and GitHub.

Since I want to include a license file also on GitHub, it contains the line:

.. include:: transcrypt/license_reference.txt

However this works neither on PyPi (whole file not parsed correctly) nor on GitHub (include directive ignored)

Can anyone shed a light on what I am doing wrong?

Solution

  • Looks like Github's team thinks (and they are probably right) that allowing the include directive could be a major security flaw : https://github.com/github/markup/issues/172

    I suppose they've deactivated the file-insertion-enabled parameter of their rst render engine :)