ewokssphinx


Nameewokssphinx JSON
Version 0.1.1 PyPI version JSON
download
home_pageNone
SummaryEwoks Sphinx directives
upload_time2025-02-03 16:39:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
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.
keywords ewoks sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # ewokssphinx

A set of Sphinx directives for Ewoks

## Quick start

```bash
pip install ewokssphinx
```

Then, add `ewokssphinx` to the list of `extensions` in the Sphinx configuration file:

```python
# conf.py

...

extensions = [
    ...,
    "ewokssphinx"
]
```

## Contents

There is only one directive for now.

### 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.*
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ewokssphinx",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "ewoks, sphinx",
    "author": null,
    "author_email": "ESRF <dau-pydev@esrf.fr>",
    "download_url": "https://files.pythonhosted.org/packages/4e/b3/7095dc2dd3a9619ce2cdf3bfa3c8930a283df9f42e6cf6d488d95b2139a7/ewokssphinx-0.1.1.tar.gz",
    "platform": null,
    "description": "# ewokssphinx\n\nA set of Sphinx directives for Ewoks\n\n## Quick start\n\n```bash\npip install ewokssphinx\n```\n\nThen, add `ewokssphinx` to the list of `extensions` in the Sphinx configuration file:\n\n```python\n# conf.py\n\n...\n\nextensions = [\n    ...,\n    \"ewokssphinx\"\n]\n```\n\n## Contents\n\nThere is only one directive for now.\n\n### Ewoks tasks directive\n\nThe `ewokstasks` directive will generate documentation automatically for the Ewoks **class** tasks contained in the module. As for `autodoc`, the module must be importable.\n\n_Example_: \n```\n.. ewokstasks:: ewoksxrpd.tasks.integrate\n```\n\nIt 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`:\n\n```\n.. ewokstasks:: ewoksxrpd.tasks.*\n```\n",
    "bugtrack_url": null,
    "license": "# MIT License\n        \n        **Copyright (c) 2025 European Synchrotron Radiation Facility**\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy of\n        this software and associated documentation files (the \"Software\"), to deal in\n        the Software without restriction, including without limitation the rights to\n        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\n        the Software, and to permit persons to whom the Software is furnished to do so,\n        subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n        ",
    "summary": "Ewoks Sphinx directives",
    "version": "0.1.1",
    "project_urls": {
        "Changelog": "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/CHANGELOG.md",
        "Documentation": "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/-/blob/main/README.md",
        "Homepage": "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/",
        "Issues": "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/issues",
        "Repository": "https://gitlab.esrf.fr/workflow/ewoks/ewokssphinx/"
    },
    "split_keywords": [
        "ewoks",
        " sphinx"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4eb37095dc2dd3a9619ce2cdf3bfa3c8930a283df9f42e6cf6d488d95b2139a7",
                "md5": "441b428a96d84d3632688966623c8afc",
                "sha256": "ab94f4378b303753bac7e3fabead9425afc111bcae9c1f834656871b4fa923dc"
            },
            "downloads": -1,
            "filename": "ewokssphinx-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "441b428a96d84d3632688966623c8afc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 3637,
            "upload_time": "2025-02-03T16:39:10",
            "upload_time_iso_8601": "2025-02-03T16:39:10.232275Z",
            "url": "https://files.pythonhosted.org/packages/4e/b3/7095dc2dd3a9619ce2cdf3bfa3c8930a283df9f42e6cf6d488d95b2139a7/ewokssphinx-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-03 16:39:10",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ewokssphinx"
}
None
Elapsed time: 1.89862s