aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilosz Wasilewski <milosz.wasilewski@linaro.org>2020-03-05 18:30:13 +0000
committerMilosz Wasilewski <milosz.wasilewski@linaro.org>2020-03-05 18:30:13 +0000
commitd729ca8b66cbc971e2ce2e68c59f4eb9d1703a72 (patch)
tree27645005fae03d497c61e28efa5b286c017a77b9
parentd2f247269575e252837e3523eaccc41ce2ad4dd8 (diff)
mkdocs_plugin: fix issues with file paths
Signed-off-by: Milosz Wasilewski <milosz.wasilewski@linaro.org>
-rw-r--r--mkdocs_plugin/setup.py2
-rw-r--r--mkdocs_plugin/testdefinitionsmkdocs/__init__.py13
2 files changed, 7 insertions, 8 deletions
diff --git a/mkdocs_plugin/setup.py b/mkdocs_plugin/setup.py
index 49aa8616..6c04dff2 100644
--- a/mkdocs_plugin/setup.py
+++ b/mkdocs_plugin/setup.py
@@ -3,7 +3,7 @@ from setuptools import setup, find_packages
setup(
name='mkdocs-test-definitions-plugin',
- version='1.0.0',
+ version='1.0.1',
description='An MkDocs plugin that converts LAVA test definitions to documentation',
long_description='',
keywords='mkdocs python markdown wiki',
diff --git a/mkdocs_plugin/testdefinitionsmkdocs/__init__.py b/mkdocs_plugin/testdefinitionsmkdocs/__init__.py
index c2953d66..2777f97f 100644
--- a/mkdocs_plugin/testdefinitionsmkdocs/__init__.py
+++ b/mkdocs_plugin/testdefinitionsmkdocs/__init__.py
@@ -13,7 +13,7 @@ class LinaroTestDefinitionsMkDocsPlugin(BasePlugin):
new_filename = filename.split("/", 1)[1]
# remove .yaml
new_filename = new_filename.rsplit(".", 1)[0]
- new_filename = os.path.join(config['docs_dir'], new_filename)
+ tmp_filename = os.path.join(config['docs_dir'], new_filename)
filecontent = None
try:
with open(filename, "r") as f:
@@ -21,10 +21,10 @@ class LinaroTestDefinitionsMkDocsPlugin(BasePlugin):
except FileNotFoundError:
return None
try:
- content = yaml.load(filecontent)
+ content = yaml.load(filecontent, Loader=yaml.Loader)
if "metadata" in content.keys():
metadata = content["metadata"]
- mdFile = mdutils.MdUtils(file_name=new_filename, title=metadata['name'])
+ mdFile = mdutils.MdUtils(file_name=tmp_filename, title=metadata['name'])
mdFile.new_header(level=1, title="Test name: %s" % metadata['name'])
mdFile.new_header(level=1, title="Description")
mdFile.new_paragraph(metadata['description'])
@@ -39,12 +39,12 @@ class LinaroTestDefinitionsMkDocsPlugin(BasePlugin):
for item in scope_list:
mdFile.new_line(" * %s" % item)
try:
- os.makedirs(os.path.dirname(new_filename))
+ os.makedirs(os.path.dirname(tmp_filename))
except OSError as exc: # Guard against race condition
if exc.errno != errno.EEXIST:
raise
mdFile.create_md_file()
- return mdFile.file_name + ".md"
+ return new_filename + ".md"
except yaml.YAMLError:
return None
except KeyError:
@@ -57,7 +57,6 @@ class LinaroTestDefinitionsMkDocsPlugin(BasePlugin):
new_filename = os.path.join(root, filename)
markdown_filename = self.generate_yaml_markdown(new_filename, config)
if markdown_filename is not None:
- f = File(markdown_filename, "./docs", "./docs", False)
+ f = File(markdown_filename, config['docs_dir'], config['site_dir'], False)
files.append(f)
-
return files