task2md 1.1.0__tar.gz → 1.1.2__tar.gz

{task2md-1.1.0 → task2md-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: task2md
-Version: 1.1.0
+Version: 1.1.2
 Summary: A program to generate markdown documentation files from Task files
 Project-URL: Homepage, https://gitlab.com/op_so/task/task2md
 Project-URL: Documentation, https://op_so.gitlab.io/task/task2md/

{task2md-1.1.0 → task2md-1.1.2}/docs/index.md

@@ -1,6 +1,6 @@
 # Overview
 
-Version: 1.1.0
+Version: 1.1.2
 
 A CLI tool to generate from [Task](https://taskfile.dev/) files, some markdown
 documentation files for [`mkdocs`](https://squidfunk.github.io/mkdocs-material/) static site.

task2md-1.1.2/docs/task/file.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.template.file

task2md-1.1.2/docs/task/header.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.template.header

task2md-1.1.2/docs/task/index.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.template.index

task2md-1.1.2/docs/task/task.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.template.task

task2md-1.1.2/docs/task/variable.md

@@ -0,0 +1,2 @@
+
+::: src.task2md.template.variable

{task2md-1.1.0 → task2md-1.1.2}/mkdocs.yml

@@ -17,8 +17,9 @@ nav:
   - 'task2md.md'
   - 'util':
     - 'util/dir.md'
-  - 'task':
-    - 'task/file.md'
-    - 'task/header.md'
-    - 'task/task.md'
-    - 'task/variable.md'
+  - 'template':
+    - 'template/file.md'
+    - 'template/header.md'
+    - 'template/index.md'
+    - 'template/task.md'
+    - 'template/variable.md'

{task2md-1.1.0 → task2md-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "task2md"
-version = "1.1.0"
+version = "1.1.2"
 description = "A program to generate markdown documentation files from Task files"
 authors = [
     { name = "FX Soubirou", email = "soubirou@yahoo.fr" }

{task2md-1.1.0 → task2md-1.1.2}/src/task2md/task2md.py

@@ -11,7 +11,7 @@ from task2md.util.dir import Dir
 
 
 @click.group()
-@click.version_option("1.1.0", prog_name="task2md")
+@click.version_option("1.1.2", prog_name="task2md")
 def cli() -> None:
     """A CLI tool to generate markdown documentation files from Task files."""
     pass
@@ -72,6 +72,7 @@ def dir(
                     f"Task documentation generated: {task_file.get_filename()}.md"
                 )
             filename = "index"
+            index_file.task_files.sort()
             index_file.generate(out_dir)
             click.echo("Index documentation generated: index.md")
 

{task2md-1.1.0 → task2md-1.1.2}/src/task2md/template/file.py

@@ -248,3 +248,11 @@ class File(BaseModel):
             output += task.to_md(self.get_filename())
 
         return output
+
+    def __lt__(self, other: "File") -> bool:
+        """A custom comparison function for sorting by name
+
+        Returns:
+            str: True if object is lower than other
+        """
+        return bool(self.get_filename() < other.get_filename())

{task2md-1.1.0 → task2md-1.1.2}/src/task2md/template/index.py

@@ -45,6 +45,6 @@ List of templates:
             description = file.header.description
             tags = ", ".join(file.header.tags)
 
-            output += f"| [{name}]({name}) | {description} | {tags} |\n"
+            output += f"| [{name}]({name}.md) | {description} | {tags} |\n"
 
         return output + "\n"

{task2md-1.1.0 → task2md-1.1.2}/tests/task/test_index.py

@@ -28,5 +28,5 @@ class TestFile:
         output = i.to_md()
         assert "# Available task templates" in output
         assert "| Templates | Description | Tags   |" in output
-        assert "| [lint1](lint1) | desc1 | tag11, tag12, tag13 |" in output
-        assert "| [lint2](lint2) | desc2 | tag21, tag22 |" in output
+        assert "| [lint1](lint1.md) | desc1 | tag11, tag12, tag13 |" in output
+        assert "| [lint2](lint2.md) | desc2 | tag21, tag22 |" in output

{task2md-1.1.0 → task2md-1.1.2}/tests/test_dir.py

@@ -58,10 +58,10 @@ class TestDir:
         assert "    - yamllint or docker" in output
         output_index = self.get_output_content("index.md")
         assert (
-            "| [lint](lint) | A set of tasks to lint different types of files. "
+            "| [lint](lint.md) | A set of tasks to lint different types of files. "
             "| lint, docker, CI |" in output_index
         )
-        assert "| [empty](empty) | - |  |" in output_index
+        assert "| [empty](empty.md) | - |  |" in output_index
         os.remove("empty.md")
         os.remove("lint.md")
         os.remove("index.md")

task2md-1.1.0/docs/task/file.md

@@ -1,2 +0,0 @@
-
-::: src.task2md.task.file

task2md-1.1.0/docs/task/header.md

@@ -1,2 +0,0 @@
-
-::: src.task2md.task.header

task2md-1.1.0/docs/task/task.md

@@ -1,2 +0,0 @@
-
-::: src.task2md.task.task

task2md-1.1.0/docs/task/variable.md

@@ -1,2 +0,0 @@
-
-::: src.task2md.task.variable