autosummary: include directives

timmie avatartimmie created an issue

.. include:: directive does not work in templates for autosummay whereas .. literalinclude:: works quite well.

I created a stub file template which takes automatically pregenerated input files.

The temaplate looks like:


{{ fullname }}
{{ underline }}

.. automodule:: {{ fullname }}

.. literalinclude:: ../input/files/{{ fullname }}.txt

This works quite well and all files referenced by relative paths are beng found.

If change to

{{ fullname }}
{{ underline }}

.. automodule:: {{ fullname }}

.. include:: ../input/files/{{ fullname }}.txt

include in order to get ReST support I get an error:

C:\code\myproject\doc\source\_templates\autosummary_template_scripts.rst:: (SEVERE/4) Problems with "include" directive path:
IOError: [Errno 2] No such file or directory: u'source/_templates/input/files/{{ fullname }}.txt'.

Why does this happen? A misconfiguration or a bug?

Comments (2)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.