Skip to content

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

Merged
merged 24 commits into from
Jan 4, 2023

Conversation

boegel
Copy link
Member

@boegel boegel commented Oct 31, 2022

  • 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

@easybuilders easybuilders deleted a comment from boegelbot Dec 6, 2022
@easybuilders easybuilders deleted a comment from boegelbot Dec 6, 2022
@migueldiascosta
Copy link
Member

@boegel is this a blocker for 4.7.0?

@boegel
Copy link
Member Author

boegel commented Jan 2, 2023

@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).

@easybuilders easybuilders deleted a comment from boegelbot Jan 2, 2023
@easybuilders easybuilders deleted a comment from boegelbot Jan 3, 2023
Copy link
Member

@branfosj branfosj left a 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'],
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"*homepage*: %s" % software[key][-1]['homepage'],
"*homepage*: <%s>" % software[key][-1]['homepage'],


lines.extend([
'',
'<a anchor="%s"/>' % key.lower(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'<a anchor="%s"/>' % key.lower(),

letter = key[0].lower()
lines.extend([
'',
'<a anchor="%s"/>' % letter,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'<a anchor="%s"/>' % letter,

lines.extend([
'',
'<a anchor="%s"/>' % letter,
"### *%s*" % letter.upper(),
Copy link
Member

@branfosj branfosj Jan 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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),

Copy link
Member

@branfosj branfosj left a 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

@Flamefire
Copy link
Contributor

This seemingly broke the test suite with the type "developement"

@branfosj
Copy link
Member

branfosj commented Jan 4, 2023

This seemingly broke the test suite with the type "developement"

Yes, in combination with #4154

There is a fix in #4155

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants