needreport¶

needreport documents the following configurations from conf.py:

• Types

• Links

• Options

and it also adds some needs metrics using the usage option.

To use the needreport directive, you need to set the needs_report_template configuration variable. If you do not set the needs_report_template configuration variable, the plugin uses the default needs report template.

The needs_report_template value is a path to the jinja2 template file. You can use the template file to customise the content generated by needreport.

Example

.. needreport::
   :types:

Result

Options¶

types¶

Flag for adding information about the needs_types configuration parameter. The flag does not require any values.

Example

.. needreport::
   :types:

Result

links¶

Flag for adding information about the needs_extra_links configuration parameter. The flag does not require any values.

Example

.. needreport::
   :links:

Result

options¶

Flag for adding information about the needs_extra_options configuration parameter. The flag does not require any values.

Example

.. needreport::
   :options:

Result

usage¶

Flag for adding information about all the need objects in the current project. The flag does not require any values.

Example

.. needreport::
   :usage:

Result