Skip to content

Fixing formatting in autogenerated documentation #6

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

Closed
branfosj wants to merge 1 commit into from
Closed

Fixing formatting in autogenerated documentation #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 4 additions & 6 deletions easybuild/tools/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,7 +796,7 @@ def list_software_md(software, detailed=True):

# 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])
letter_links = ' - '.join(['[' + x + '](#' + x + ')' for x in ascii_lowercase if x in key_letters])
lines.extend([letter_links, ''])

letter = None
Expand All @@ -810,16 +810,15 @@ def list_software_md(software, detailed=True):
letter = key[0].lower()
lines.extend([
'',
'<a anchor="%s"/>' % letter,
"### *%s*" % letter.upper(),
"### %s" % letter.upper(),
'',
])

if detailed:
# 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),
' - '.join('[%s](#%s)' % (k, k.lower()) for k in sorted_keys if k[0].lower() == letter),
'',
])

Expand Down Expand Up @@ -855,12 +854,11 @@ def list_software_md(software, detailed=True):

lines.extend([
'',
'<a anchor="%s"/>' % key.lower(),
'### *%s*' % key,
'',
' '.join(software[key][-1]['description'].split('\n')).lstrip(' '),
'',
"*homepage*: %s" % software[key][-1]['homepage'],
"*homepage*: <%s>" % software[key][-1]['homepage'],
'',
] + md_title_and_table(None, table_titles, table_values))
else:
Expand Down