strictdoc icon indicating copy to clipboard operation
strictdoc copied to clipboard

Feature: Embedding text files into SDoc documents

Open stanislaw opened this issue 3 years ago • 3 comments

This feature would enable inclusion of text files into SDoc documents, something like this:

[FREETEXT]

[EMBEDDED_FILE SRC="relative/path/file.text"]

[/FREETEXT]

stanislaw avatar Jan 09 '22 12:01 stanislaw

What would be interesting is to have latex files included to enable more technical complex text.

[FREETEXT]

[EMBEDDED_FILE SRC="relative/path/file.tex"]

[/FREETEXT]

mnaderhirn avatar Jan 10 '22 09:01 mnaderhirn

This feature would enable inclusion of text files into SDoc documents, something like this:

[FREETEXT]

[EMBEDDED_FILE SRC="relative/path/file.text"]

[/FREETEXT]

rst's include directive might satisfy this https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#include-code-with-the-literalinclude-directive

BenGardiner avatar Mar 31 '22 21:03 BenGardiner

This feature would enable inclusion of text files into SDoc documents, something like this:

[FREETEXT]

[EMBEDDED_FILE SRC="relative/path/file.text"]

[/FREETEXT]

rst's include directive might satisfy this https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html#include-code-with-the-literalinclude-directive

Just checked this. It looks like this directive is part of Sphinx, not Docutils.

It needs to be investigated if Docutils's publish_parts could be replaced with something similar of Sphinx:

from docutils.core import publish_parts

stanislaw avatar May 14 '22 12:05 stanislaw