Skip to content

Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks | Closes #221 #226

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
plaindocs merged 4 commits into from
Dec 3, 2025
Merged

Fix [Sphinx] [Automation] Issue -> PR conversion of hyperlinks | Closes #221 #226

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d300a56
Fix: Normalize Markdown links and formatting
MarcosBorgesPhD Nov 20, 2025
210bf72
Fix: address CI failure by updating snapshot-ci.yml
MarcosBorgesPhD Nov 20, 2025
82e2619
Fix: address CI failure by updating Pandoc installation
MarcosBorgesPhD Nov 21, 2025
a8b0c6a
Remove parts requested by @plaindocs
MarcosBorgesPhD Dec 2, 2025
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
31 changes: 31 additions & 0 deletions scripts/auto-pr-helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,34 @@
def md_to_rst(markdown: str) -> str:
return convert(markdown)

def normalize_md(issue_body: str) -> str:
"""
Fix links and mixed bold/code that confuse Markdown parser
"""
# Fix links with inline-code: [`link`](url) => [link](url)
issue_body = re.sub(
r"\[\s*`([^`]+)`\s*\]\(([^)]+)\)",
r"[\1](\2)",
issue_body
)

# Fix mixed bold/code formatting
# **`code`** => `code`
issue_body = re.sub(
r"\*\*`([^`]+)`\*\*",
r"`\1`",
issue_body
)

# `**code**` => `code`
issue_body = re.sub(
r"`\*\*([^`]+)\*\*`",
r"`\1`",
issue_body
)

return issue_body
Comment thread
MarcosBorgesPhD marked this conversation as resolved.


def extract_form_fields(issue_body: str) -> dict:
"""
Expand Down Expand Up @@ -139,7 +167,10 @@ def format_code_block(code: str, lang: str = "rust") -> str:

issue_number = json_issue["number"]
issue_title = json_issue["title"]

issue_body = json_issue["body"]
issue_body = normalize_md(issue_body)

fields = extract_form_fields(issue_body)
chapter = fields["chapter"]
content = guideline_template(fields)
Expand Down