Skip to content

feat: linkify library notes #321

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

feat: linkify library notes #321

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7371f70
WIP: link to library notes in the doc-gen output
Vierkantor Oct 9, 2025
dd29fca
Change the check, maybe this works better?
Vierkantor Oct 9, 2025
f7b6c5a
Debug
Vierkantor Oct 9, 2025
b6eadd7
Don't forget to actually call your new function. aaa
Vierkantor Oct 9, 2025
e33e382
Quote the reference so it gets parsed.
Vierkantor Oct 9, 2025
c7881de
Format it clearly as link destination
Vierkantor Oct 9, 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
23 changes: 22 additions & 1 deletion DocGen4/Output/DocString.lean
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,24 @@ partial def modifyElement (element : Element) (funName : String) : HtmlM Element
else
return ⟨ name, attrs, ← modifyContents contents funName modifyElement ⟩

/-- Find all library note references in a markdown text. -/
partial def findAllNotes (s : String) (i : String.Pos := 0)
(ret : Std.HashSet String := ∅) : Std.HashSet String :=
let lps := s.posOfAux '[' s.endPos i
if lps < s.endPos then
let lpe := s.posOfAux ']' s.endPos lps
if lpe < s.endPos then
let expected := "note "
if (Substring.toString ⟨s, lps - expected.endPos, lps⟩).toLower == expected then
let citekey := Substring.toString ⟨s, ⟨lps.1 + 1⟩, lpe⟩
findAllNotes s lpe (ret.insert citekey)
else
findAllNotes s lpe ret
else
ret
else
ret

/-- Find all references in a markdown text. -/
partial def findAllReferences (refsMap : Std.HashMap String BibItem) (s : String) (i : String.Pos := 0)
(ret : Std.HashSet String := ∅) : Std.HashSet String :=
Expand All @@ -259,10 +277,13 @@ partial def findAllReferences (refsMap : Std.HashMap String BibItem) (s : String

/-- Convert docstring to Html. -/
def docStringToHtml (docString : String) (funName : String) : HtmlM (Array Html) := do
let notesMarkdown := "\n\n" ++ (String.join <|
(findAllNotes docString).toList.map fun s =>
s!"[{s}]: <##Mathlib.LibraryNote.«{s}»>\n")
let refsMarkdown := "\n\n" ++ (String.join <|
(findAllReferences (← read).refsMap docString).toList.map fun s =>
s!"[{s}]: references.html#ref_{s}\n")
match MD4Lean.renderHtml (docString ++ refsMarkdown) with
match MD4Lean.renderHtml (docString ++ notesMarkdown ++ refsMarkdown) with
| .some rendered =>
match manyDocument rendered.mkIterator with
| .success _ res =>
Expand Down