Skip to content

fix several linter issues for auto-generated MarkDown #4162

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
boegel merged 2 commits into from
Jan 5, 2023
Merged

fix several linter issues for auto-generated MarkDown #4162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb49ff1
Autogenerated Markdown fixes
branfosj Jan 5, 2023
7add3ab
and fix the related tests
branfosj Jan 5, 2023
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: 5 additions & 5 deletions easybuild/tools/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ def avail_cfgfile_constants_md(go_cfg_constants):
for section in go_cfg_constants:
if section != go_cfg_constants['DEFAULT']:
doc.extend([
"### Only in '%s' section:" % section,
"## Only in '%s' section:" % section,
'',
])
table_titles = ["Constant name", "Constant help", "Constant value"]
Expand Down Expand Up @@ -565,8 +565,8 @@ def avail_easyconfig_templates_md():
doc.extend(md_title_and_table(title, table_titles, table_values, title_level=2))
doc.append('')

title = 'Template names/values as set in easyconfig'
doc.extend([title, '-' * len(title), ''])
title = '## Template names/values as set in easyconfig'
doc.extend([title, ''])
for name in TEMPLATE_NAMES_CONFIG:
doc.append('* ``%%(%s)s``' % name)
doc.append('')
Expand Down Expand Up @@ -812,7 +812,7 @@ def list_software_md(software, detailed=True):
letter = key[0].lower()
lines.extend([
'',
"### %s" % letter.upper(),
"## %s" % letter.upper(),
'',
])

Expand Down Expand Up @@ -1326,7 +1326,7 @@ def gen_easyblock_doc_section_md(eb_class, path_to_examples, common_params, doc_
for base in eb_class.__bases__:
bname = base.__name__
if base in all_eb_classes:
bases.append("<a href='#" + bname.lower() + "'>``" + bname + "``</a>")
bases.append("[``" + bname + "``](#" + bname.lower() + ")")
else:
bases.append('``' + bname + '``')

Expand Down
6 changes: 3 additions & 3 deletions test/framework/docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@
[g](#g)


### G
## G

* GCC
* gzip"""
Expand All @@ -378,7 +378,7 @@
[g](#g)


### G
## G


[GCC](#gcc) - [gzip](#gzip)
Expand Down Expand Up @@ -714,7 +714,7 @@ def test_avail_cfgfile_constants(self):

md_patterns = [
r"^# Constants available \(only\) in configuration files",
r"^### Only in 'DEFAULT' section:",
r"^## Only in 'DEFAULT' section:",
r"^``HOME``\s*\|Current user's home directory, expanded '~'\s*\|``%s``$" % os.getenv('HOME'),
r"^``USER``\s*\|Current username, translated uid from password file\s*\|``%s``" % os.getenv('USER'),
]
Expand Down