MISP
/
misp-modules
mirror of https://github.com/MISP/misp-modules
2
0
Fork 0
Code Issues Releases Wiki Activity

fix: [documentation] Fixed path for the documentation README file to be written to

pull/617/head
Christian Studer 2023-05-31 15:25:08 +02:00
parent cfb8ab09d0
commit 830a6b79cd
No known key found for this signature in database
GPG Key ID: 6BBED1B63A6D639F
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
documentation/generate_documentation.py
View File

@ -2,6 +2,7 @@
import os import os
import json import json
import sys import sys
from pathlib import Path
module_types = ['expansion', 'export_mod', 'import_mod'] module_types = ['expansion', 'export_mod', 'import_mod']
titles = ['Expansion Modules', 'Export Modules', 'Import Modules'] titles = ['Expansion Modules', 'Export Modules', 'Import Modules']
@ -53,7 +54,7 @@ def write_doc(root_path):
for _path, title in zip(module_types, titles): for _path, title in zip(module_types, titles):
markdown.append(f'\n## {title}\n') markdown.append(f'\n## {title}\n')
markdown.extend(generate_doc(_path, root_path)) markdown.extend(generate_doc(_path, root_path))
with open('README.md', 'w') as w: with open(root_path / 'README.md', 'w') as w:
w.write(''.join(markdown)) w.write(''.join(markdown))
@ -65,6 +66,6 @@ def write_docs_for_mkdocs(root_path):
if __name__ == '__main__': if __name__ == '__main__':
root_path = os.path.dirname(os.path.realpath(__file__)) root_path = Path(__file__).resolve().parent
write_doc(root_path) write_doc(root_path)
write_docs_for_mkdocs(root_path) write_docs_for_mkdocs(root_path)