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

Add line wrap for examples in documentation #139

Merged
merged 3 commits into from
Feb 23, 2024
Merged

Conversation

AVHopp
Copy link
Collaborator

@AVHopp AVHopp commented Feb 23, 2024

This PR ensures that long lines are wrapped in the files that are created when executing the examples as jupyter notebooks.

A line is now wrapped when it is longer than the size that we allow for our python code, which is 88 characters. The only exception is when a link in detected since a line wrap might break this link. This is done by checking whether the sequence ]( is present in the line.

docs/scripts/utils.py Show resolved Hide resolved
docs/scripts/utils.py Show resolved Hide resolved
@AVHopp AVHopp self-assigned this Feb 23, 2024
@AVHopp AVHopp added bug Something isn't working documentation Improvements or additions to documentation labels Feb 23, 2024
@AVHopp AVHopp merged commit 72e1fbf into main Feb 23, 2024
9 checks passed
@AVHopp AVHopp deleted the doc/wrap_notebooks branch February 23, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants