Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
c-bebop opened this issue Feb 21, 2024 · 0 comments
Open

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

c-bebop opened this issue Feb 21, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@c-bebop
Copy link
Collaborator

c-bebop commented Feb 21, 2024

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.

@c-bebop c-bebop added the bug Something isn't working label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant