File: convert_readme.py

package info (click to toggle)
python-einops 0.8.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,584 kB
  • sloc: python: 4,105; makefile: 6
file content (28 lines) | stat: -rw-r--r-- 939 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
"""
Converts readme from github repo page to mkdocs-friendly
"""

from pathlib import Path

original_text = Path(__file__).parent.parent.joinpath("README.md").read_text(encoding="utf-8")


def replace_with_video_tag(line: str):
    if line.startswith("https://") and line.endswith(".mp4") and " " not in line:
        # treating as link to mp4 file.
        return ""
        # return f"""
        # <video width="800" controls><source src="{line}" type="video/mp4">
        # Your browser does not support the video </video>\n\n<br />\n\n<br />
        # """.strip()
    else:
        # other lines are not touched
        return line


new_content = "\n".join([replace_with_video_tag(line) for line in original_text.splitlines()])
# save contents
docs_index = Path(__file__).parent.parent.joinpath("docs_src", "index.md")
assert docs_index.parent.exists()
docs_index.write_bytes(new_content.encode("utf-8"))
print("Converted README.md")