add support for using --output-format=md (MarkDown)#4117
Merged
branfosj merged 24 commits intoeasybuilders:developfrom Jan 4, 2023
Merged
add support for using --output-format=md (MarkDown)#4117branfosj merged 24 commits intoeasybuilders:developfrom
branfosj merged 24 commits intoeasybuilders:developfrom
Conversation
…and '--avail-easyconfig-constants --output-format md'
…blocks triggering failing docs tests
Member
|
@boegel is this a blocker for 4.7.0? |
Member
Author
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
This was referenced Jan 3, 2023
branfosj
requested changes
Jan 4, 2023
Member
branfosj
left a comment
There was a problem hiding this comment.
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'], |
Member
There was a problem hiding this comment.
Suggested change
| "*homepage*: %s" % software[key][-1]['homepage'], | |
| "*homepage*: <%s>" % software[key][-1]['homepage'], |
|
|
||
| lines.extend([ | ||
| '', | ||
| '<a anchor="%s"/>' % key.lower(), |
Member
There was a problem hiding this comment.
Suggested change
| '<a anchor="%s"/>' % key.lower(), |
| letter = key[0].lower() | ||
| lines.extend([ | ||
| '', | ||
| '<a anchor="%s"/>' % letter, |
Member
There was a problem hiding this comment.
Suggested change
| '<a anchor="%s"/>' % letter, |
| lines.extend([ | ||
| '', | ||
| '<a anchor="%s"/>' % letter, | ||
| "### *%s*" % letter.upper(), |
Member
There was a problem hiding this comment.
Suggested change
| "### *%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]) |
Member
There was a problem hiding this comment.
Suggested change
| 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), |
Member
There was a problem hiding this comment.
Suggested change
| ' - '.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), |
branfosj
approved these changes
Jan 4, 2023
Member
branfosj
left a comment
There was a problem hiding this comment.
We'll put the suggested changes into a future PR
This was referenced Jan 4, 2023
Contributor
|
This seemingly broke the test suite with the type "developement" |
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
eb --avail-cfgfile-constants --output-format mdeb --avail-easyconfig-constants --output-format mdeb --avail-easyconfig-licenses --output-format mdeb --avail-easyconfig-params --output-format mdeb --avail-easyconfig-templates --output-format mdeb --avail-toolchain-opts ... --output-format mdeb --list-easyblocks --output-format mdeb --list-software --output-format mdeb --list-toolchains --output-format mdeb --help-mdgen_easyblocks_overview_md