Skip to content

Documentation: Code Snippets from File Add Additional New Line #170

@c-bebop

Description

@c-bebop

In our documentation whenever we added a code snippet that is read from file using literalinclude e.g.:

https://github.com/hu-macsy/simexpal/blob/master/docs/quick_start.rst?plain=1#L370

the code snippet will have additional new lines when copy & paste the code into an editor. I could not find a quick fix for this issue. I do assume that the issue comes from sphinx and how it renders those include code snippets. A similar issue was once reported but I can't really see if that was really fixed or not.

It would be great if we could fix this issue - if that is possible from our side - or at least report it to the Sphinx bug tracker which is either the readthedocs Sphinx Theme on GitHub or Sphinx Github.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions