ewokssphinx
A set of Sphinx directives for Ewoks
Quick start
pip install ewokssphinx
Then, add ewokssphinx to the list of extensions in the Sphinx configuration file:
# 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.*
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
ewokssphinx-0.1.1.tar.gz
(3.6 kB
view details)
File details
Details for the file ewokssphinx-0.1.1.tar.gz.
File metadata
- Download URL: ewokssphinx-0.1.1.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ab94f4378b303753bac7e3fabead9425afc111bcae9c1f834656871b4fa923dc
|
|
| MD5 |
441b428a96d84d3632688966623c8afc
|
|
| BLAKE2b-256 |
4eb37095dc2dd3a9619ce2cdf3bfa3c8930a283df9f42e6cf6d488d95b2139a7
|
