ewokssphinx 0.1.0__tar.gz

ewokssphinx-0.1.0/LICENSE.md

@@ -0,0 +1,20 @@
+# MIT License
+
+**Copyright (c) 2025 European Synchrotron Radiation Facility**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ewokssphinx-0.1.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.2
+Name: ewokssphinx
+Version: 0.1.0
+Summary: Ewoks Sphinx directives
+Author-email: ESRF <dau-pydev@esrf.fr>
+License: # MIT License
+        
+        **Copyright (c) 2025 European Synchrotron Radiation Facility**
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+        the Software, and to permit persons to whom the Software is furnished to do so,
+        subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/
+Project-URL: Documentation, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/README.md
+Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/
+Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/issues
+Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/CHANGELOG.md
+Keywords: ewoks,sphinx
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: docutils
+Requires-Dist: ewokscore==1.1.0
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ewokssphinx[test]; extra == "dev"
+Requires-Dist: black>=25; extra == "dev"
+Requires-Dist: flake8>=4; extra == "dev"
+
+# ewokssphinx
+
+A set of Sphinx directives for Ewoks
+
+## Ewoks tasks directive
+
+The `ewokstasks` directive will generate documentation automatically for the Ewoks **class** tasks contained in the module. As for `autodoc`, the module must be importable.
+
+_Example_: 
+```
+.. ewokstasks:: ewoksxrpd.tasks.integrate
+```
+
+It is also possible to give a pattern for recursive generation. For example, The following command will generate documentation for all class tasks contained in the modules of `ewoksxrpd.tasks`:
+
+```
+.. ewokstasks:: ewoksxrpd.tasks.*
+```

ewokssphinx-0.1.0/README.md

@@ -0,0 +1,18 @@
+# ewokssphinx
+
+A set of Sphinx directives for Ewoks
+
+## Ewoks tasks directive
+
+The `ewokstasks` directive will generate documentation automatically for the Ewoks **class** tasks contained in the module. As for `autodoc`, the module must be importable.
+
+_Example_: 
+```
+.. ewokstasks:: ewoksxrpd.tasks.integrate
+```
+
+It is also possible to give a pattern for recursive generation. For example, The following command will generate documentation for all class tasks contained in the modules of `ewoksxrpd.tasks`:
+
+```
+.. ewokstasks:: ewoksxrpd.tasks.*
+```

ewokssphinx-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=46.4"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ewokssphinx"
+version = "0.1.0"
+keywords = ['ewoks', 'sphinx']
+authors = [{ name = "ESRF", email = "dau-pydev@esrf.fr" }]
+description = "Ewoks Sphinx directives"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE.md" }
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+requires-python = ">=3.8"
+dependencies = ["docutils", "ewokscore==1.1.0"]
+
+[project.urls]
+Homepage = "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/"
+Documentation = "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/README.md"
+Repository = "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/"
+Issues = "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/issues"
+Changelog = "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/CHANGELOG.md"
+
+[project.optional-dependencies]
+test = ["pytest >=7"]
+dev = ["ewokssphinx[test]", "black >=25", "flake8 >=4"]
+
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.coverage.run]
+omit = ['*/tests/*']

ewokssphinx-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ewokssphinx-0.1.0/src/ewokssphinx/__init__.py

@@ -0,0 +1,5 @@
+from .ewoks_task_directive import EwoksTaskDirective
+
+
+def setup(app):
+    app.add_directive("ewokstasks", EwoksTaskDirective)

ewokssphinx-0.1.0/src/ewokssphinx/ewoks_task_directive.py

@@ -0,0 +1,57 @@
+from docutils.parsers.rst import Directive
+from docutils import nodes
+from ewokscore.task_discovery import (
+    _iter_discover_tasks_from_modules,
+    _iter_modules_from_pattern,
+)
+
+from .utils import field
+
+
+class EwoksTaskDirective(Directive):
+    required_arguments = 1
+    optional_arguments = 0
+    final_argument_whitespace = True
+    option_spec = {}
+    has_content = False
+
+    def run(self):
+
+        module_pattern = self.arguments[0]
+        results = []
+        for module in _iter_modules_from_pattern(module_pattern):
+            for task in _iter_discover_tasks_from_modules(module, task_type="class"):
+                results.extend(
+                    [
+                        nodes.title(
+                            text=task["task_identifier"].split(".")[-1],
+                        ),
+                        nodes.paragraph(text=task["description"]),
+                        nodes.field_list(
+                            "",
+                            nodes.field(
+                                "",
+                                nodes.field_name(text="Identifier"),
+                                nodes.field_body(
+                                    "",
+                                    nodes.paragraph(
+                                        "",
+                                        "",
+                                        nodes.literal(text=task["task_identifier"]),
+                                    ),
+                                ),
+                            ),
+                            field("Task type", task["task_type"]),
+                            field(
+                                "Required inputs",
+                                ",".join(task["required_input_names"]),
+                            ),
+                            field(
+                                "Optional inputs",
+                                ",".join(task["optional_input_names"]),
+                            ),
+                            field("Outputs", ",".join(task["output_names"])),
+                        ),
+                    ]
+                )
+        return results

ewokssphinx-0.1.0/src/ewokssphinx/utils.py

@@ -0,0 +1,13 @@
+from docutils import nodes
+from docutils.nodes import Node
+
+
+def field(name: str, value: str) -> Node:
+    return nodes.field(
+        "",
+        nodes.field_name(text=name),
+        nodes.field_body(
+            "",
+            nodes.paragraph("", text=value),
+        ),
+    )

ewokssphinx-0.1.0/src/ewokssphinx.egg-info/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.2
+Name: ewokssphinx
+Version: 0.1.0
+Summary: Ewoks Sphinx directives
+Author-email: ESRF <dau-pydev@esrf.fr>
+License: # MIT License
+        
+        **Copyright (c) 2025 European Synchrotron Radiation Facility**
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of
+        this software and associated documentation files (the "Software"), to deal in
+        the Software without restriction, including without limitation the rights to
+        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+        the Software, and to permit persons to whom the Software is furnished to do so,
+        subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Homepage, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/
+Project-URL: Documentation, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/README.md
+Project-URL: Repository, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/
+Project-URL: Issues, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/issues
+Project-URL: Changelog, https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/CHANGELOG.md
+Keywords: ewoks,sphinx
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: docutils
+Requires-Dist: ewokscore==1.1.0
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Provides-Extra: dev
+Requires-Dist: ewokssphinx[test]; extra == "dev"
+Requires-Dist: black>=25; extra == "dev"
+Requires-Dist: flake8>=4; extra == "dev"
+
+# ewokssphinx
+
+A set of Sphinx directives for Ewoks
+
+## Ewoks tasks directive
+
+The `ewokstasks` directive will generate documentation automatically for the Ewoks **class** tasks contained in the module. As for `autodoc`, the module must be importable.
+
+_Example_: 
+```
+.. ewokstasks:: ewoksxrpd.tasks.integrate
+```
+
+It is also possible to give a pattern for recursive generation. For example, The following command will generate documentation for all class tasks contained in the modules of `ewoksxrpd.tasks`:
+
+```
+.. ewokstasks:: ewoksxrpd.tasks.*
+```

ewokssphinx-0.1.0/src/ewokssphinx.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE.md
+README.md
+pyproject.toml
+src/ewokssphinx/__init__.py
+src/ewokssphinx/ewoks_task_directive.py
+src/ewokssphinx/utils.py
+src/ewokssphinx.egg-info/PKG-INFO
+src/ewokssphinx.egg-info/SOURCES.txt
+src/ewokssphinx.egg-info/dependency_links.txt
+src/ewokssphinx.egg-info/requires.txt
+src/ewokssphinx.egg-info/top_level.txt

ewokssphinx-0.1.0/src/ewokssphinx.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ewokssphinx-0.1.0/src/ewokssphinx.egg-info/requires.txt

@@ -0,0 +1,10 @@
+docutils
+ewokscore==1.1.0
+
+[dev]
+ewokssphinx[test]
+black>=25
+flake8>=4
+
+[test]
+pytest>=7

ewokssphinx-0.1.0/src/ewokssphinx.egg-info/top_level.txt

@@ -0,0 +1 @@
+ewokssphinx