External/json
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

🚨 adjust warnings for index.md files

Browse Source
This commit is contained in:
Niels Lohmann 2022-05-08 12:45:25 +02:00
parent 14c523c611
commit 3905522ff3
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/mkdocs/scripts/check_structure.py
View File

@ -83,7 +83,8 @@ def check_structure():
report('structure/section_order', f'{file}:{lineno+1}', f'section "{current_section}" is in an unexpected order (should be before "{expected_sections[section_idx]}")') report('structure/section_order', f'{file}:{lineno+1}', f'section "{current_section}" is in an unexpected order (should be before "{expected_sections[section_idx]}")')
section_idx = idx section_idx = idx
else: else:
report('structure/unknown_section', f'{file}:{lineno+1}', f'section "{current_section}" is not part of the expected sections') if 'index.md' not in file: # index.md files may have a different structure
report('structure/unknown_section', f'{file}:{lineno+1}', f'section "{current_section}" is not part of the expected sections')
# code example # code example
if line == '```cpp' and section_idx == -1: if line == '```cpp' and section_idx == -1:
@ -107,9 +108,10 @@ def check_structure():
previous_line = line previous_line = line
for required_section in required_sections: if 'index.md' not in file: # index.md files may have a different structure
if required_section not in existing_sections: for required_section in required_sections:
report('structure/missing_section', f'{file}:{lineno+1}', f'required section "{required_section}" was not found') if required_section not in existing_sections:
report('structure/missing_section', f'{file}:{lineno+1}', f'required section "{required_section}" was not found')
def check_examples(): def check_examples():