Skip to content

Add Javadoc Escapes to README Overview #12627

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
alzimmermsft merged 5 commits into from
Jul 8, 2020
Merged

Add Javadoc Escapes to README Overview #12627

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df9df89
Add invalid Javadoc character escaping to the README overview injection
alzimmermsft Jun 29, 2020
7160886
Merge branch 'master' into AzEng_UpdateReadmeInjectionToEscape
alzimmermsft Jul 7, 2020
6831023
Replace leading '@' with Javadoc safe '{@literal @}'
alzimmermsft Jul 7, 2020
2b546fa
Merge branch 'master' into AzEng_UpdateReadmeInjectionToEscape
alzimmermsft Jul 8, 2020
2ef9a71
Remove Azure Core README test text, updated regex to retain leading w…
alzimmermsft Jul 8, 2020
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
7 changes: 4 additions & 3 deletions eng/pipelines/scripts/generate_overview_from_readme.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.

# Use case: Given a README.md file, generate a readme_overview.html file and place it next
# Use case: Given a README.md file, generate a readme_overview.html file and place it next
# to the README.md. This will allow the javadocs jar step to append the contents of the
# readme onto the landing page.
#
#
# This script is necessary, instead of just invoking python markdown2 directly from the
# command line because the generated overview.html file needs to be enclosed inside of <body>
# tags. When the attach-javadocs runs with the overview option it will append it the contents
Expand All @@ -19,6 +19,7 @@
import markdown2
import os.path
from io import open
import re
import sys

def generate_overview(readme_file, version):
Expand All @@ -40,7 +41,7 @@ def generate_overview(readme_file, version):
# markdown2.markdown will create html from the readme.md file. The fenced-code-blocks
# extras being passed into the markdown call is necessary to deal with the embedded
# code blocks within the readme so they'll displaye correctly in the html
html_readme_content = markdown2.markdown(readme_content, extras=["fenced-code-blocks"])
html_readme_content = markdown2.markdown(re.sub(pattern='^(\s*)@', repl='\g<1>{@literal @}', string=readme_content, flags=re.MULTILINE), extras=["fenced-code-blocks"])

# Due to javadoc's iFrames the links need to target new tabs otherwise hilarity ensues
soup = BeautifulSoup(html_readme_content, "html.parser")
Expand Down