Skip to content

Add line wrap for examples in documentation #139

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.

Sign up for GitHub

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

Merged
AVHopp merged 3 commits into from
Feb 23, 2024
Merged

Add line wrap for examples in documentation #139

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f293f4f
Add line wrap for examples in documentation
AVHopp Feb 23, 2024
39f31af
Fix handling of lines that should not be contained
AVHopp Feb 23, 2024
440e1c5
Update CHANGELOG.md
AVHopp Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions docs/scripts/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Comment thread
Scienfitz marked this conversation as resolved.
import pathlib
import shutil
import textwrap
Comment thread
AVHopp marked this conversation as resolved.
Comment thread
Scienfitz marked this conversation as resolved.
from subprocess import DEVNULL, STDOUT, check_call

from tqdm import tqdm
Expand Down Expand Up @@ -158,11 +159,21 @@ def create_example_documentation(example_dest_dir: str, ignore_examples: bool):
)

# CLEANUP
# Remove all lines that try to include a png file
markdown_path = file.with_suffix(".md")
# We wrap lines which are too long as long as they do not contain a link.
# To discover whether a line contains a link, we check if the string "]("
# is contained.
with open(markdown_path, "r", encoding="UTF-8") as markdown_file:
lines = markdown_file.readlines()

content = markdown_file.read()
wrapped_lines = []
for line in content.splitlines():
if len(line) > 88 and "](" not in line:
wrapped = textwrap.wrap(line, width=88)
wrapped_lines.extend(wrapped)
else:
wrapped_lines.append(line)

lines = "\n".join(wrapped_lines)
# Delete lines we do not want to have in our documentation
lines = [line for line in lines if "![svg]" not in line]
lines = [line for line in lines if "![png]" not in line]
Expand Down