Skip to content

Commit

Permalink
Remove html image tag TODO
Browse files Browse the repository at this point in the history
  • Loading branch information
yinggeh authored Apr 8, 2024
1 parent 904c190 commit 3a90565
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,13 +323,10 @@ def replace_relpath_with_url(relpath, src_doc_path):
def replace_hyperlink(m, src_doc_path):
"""
TODO: Support of HTML tags for future docs.
1. Markdown allows <link>, e.g. <a href=[^>]+>. Whether we want to
find and replace the link depends on if they link to internal .md files
or allows relative paths. I haven't seen one such case in our doc so
should be safe for now.
2. Broken images have been found in the client repo src/grpc_generated/java/README.md.
Sphinx did not compile HTML image tags correctly. Reach out to @yinggeh for more detail.
Ex: <img src="images/proto-files.png" width="220" />
Markdown allows <link>, e.g. <a href=[^>]+>. Whether we want to
find and replace the link depends on if they link to internal .md files
or allows relative paths. I haven't seen one such case in our doc so
should be safe for now.
"""

hyperlink_str = m.group(2)
Expand Down

0 comments on commit 3a90565

Please sign in to comment.