hu-macsy / simexpal

Simplifying Experimental Algorithmics
https://simexpal.readthedocs.io
MIT License
17 stars 18 forks source link

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

Open c-bebop opened 9 months ago

c-bebop commented 9 months ago

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.