ewokssphinx 1.0.0rc0

Ewoks Sphinx directives

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

Basic use

The ewokstasks directive will generate documentation automatically for all Ewoks tasks (be it class, method or ppfmethod) contained in the module. As for autodoc, the module must be importable.

⚠️ The ewokstasks directive must be placed in the main section of the document! Do not place it in another directive (admonition or other) or the structure of the document may be broken!

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 tasks contained in the modules of ewoksxrpd.tasks:

.. ewokstasks:: ewoksxrpd.tasks.*

Options

• :task-type:: (class, method or ppfmethod)

  Generates documentation only for the specified task type.

  Example:

  To generate documentation for the Ewoks class tasks in ewoksxrpd.tasks.integrate:

  .. ewokstasks:: ewoksxrpd.tasks.integrate
      :task-type: class
  

• :ignore-import-error:

  Print a warning instead of raising an error when an import fails.

  Example:

  .. ewokstasks:: ewoksxrpd.tasks.integrate
      :ignore-import-error: