In most cases the service fetches requested data from an external server and creates a need object for each
found data-element in the returned data.
These need objects can then be used and referenced as all other need objects, e.g. by filtering them via
needtable.
Options
needservice supports all options, which are also available for the need/ req (or any other defined need type) directive.
This include also all custom options defined by needs_extra_options.
Beside this, each service can define own options, which may be needed for the service to work correctly.
Please take a look into the related service documentation to find out what is needed.
For services provided by Sphinx-Needs
please take a look into Services.
.. needservice:: <service>
:option: ...
:status: open
:tags: awesome, nice
:author: me
Extra content for each new need
debug
Set debug
to get debug-output of the needservice only. No needs will be created.
Useful to understand the return values of services or to figure out, why a connection can not be established.
.. needservice:: <service>
:debug:
Content
The content of needservice is used as content for all created need objects.
A service may deviate from this behavior and define its own usage.
For example by awaiting a json-string with a more complex configuration or by just ignoring the content.
Please take a look into the related service documentation for more information.