-
Notifications
You must be signed in to change notification settings - Fork 211
add support for using --output-format=md (MarkDown) #4117
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.
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
Conversation
…and '--avail-easyconfig-constants --output-format md'
…blocks triggering failing docs tests
@boegel is this a blocker for 4.7.0? |
To me, yes, I really want this finished and merged before releasing EasyBuild v4.7.0... I'll have time to finish it this week (working on it right now). |
…e control over title level in md_title_and_table
…with gen_easyblocks_overview_md
…locks_overview_* functions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is the right syntax to get rid of most of the problems in the https://github.com/easybuilders/easybuild-docs/actions/runs/3836711232/jobs/6531176502 without changing the internal links.
'', | ||
' '.join(software[key][-1]['description'].split('\n')).lstrip(' '), | ||
'', | ||
"*homepage*: %s" % software[key][-1]['homepage'], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"*homepage*: %s" % software[key][-1]['homepage'], | |
"*homepage*: <%s>" % software[key][-1]['homepage'], |
|
||
lines.extend([ | ||
'', | ||
'<a anchor="%s"/>' % key.lower(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'<a anchor="%s"/>' % key.lower(), |
letter = key[0].lower() | ||
lines.extend([ | ||
'', | ||
'<a anchor="%s"/>' % letter, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'<a anchor="%s"/>' % letter, |
lines.extend([ | ||
'', | ||
'<a anchor="%s"/>' % letter, | ||
"### *%s*" % letter.upper(), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"### *%s*" % letter.upper(), | |
"### %s" % letter.upper(), |
|
||
# links to per-letter tables | ||
key_letters = nub(sorted(k[0].lower() for k in software.keys())) | ||
letter_links = ' - '.join(['<a href="#' + x + '">' + x + '</a>' for x in ascii_lowercase if x in key_letters]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
letter_links = ' - '.join(['<a href="#' + x + '">' + x + '</a>' for x in ascii_lowercase if x in key_letters]) | |
letter_links = ' - '.join(['[' + x + '](#' + x + ')' for x in ascii_lowercase if x in key_letters]) |
# quick links per software package | ||
lines.extend([ | ||
'', | ||
' - '.join('<a href="#%s">%s</a>' % (k.lower(), k) for k in sorted_keys if k[0].lower() == letter), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
' - '.join('<a href="#%s">%s</a>' % (k.lower(), k) for k in sorted_keys if k[0].lower() == letter), | |
' - '.join('[%s](#%s)' % (k, k.lower()) for k in sorted_keys if k[0].lower() == letter), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll put the suggested changes into a future PR
This seemingly broke the test suite with the type "developement" |
eb --avail-cfgfile-constants --output-format md
eb --avail-easyconfig-constants --output-format md
eb --avail-easyconfig-licenses --output-format md
eb --avail-easyconfig-params --output-format md
eb --avail-easyconfig-templates --output-format md
eb --avail-toolchain-opts ... --output-format md
eb --list-easyblocks --output-format md
eb --list-software --output-format md
eb --list-toolchains --output-format md
eb --help-md
gen_easyblocks_overview_md