:py:mod:`dissect.target.helpers.docs`
=====================================

.. py:module:: dissect.target.helpers.docs




Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.helpers.docs.get_docstring
   dissect.target.helpers.docs.get_func_description
   dissect.target.helpers.docs.get_plugin_functions_desc
   dissect.target.helpers.docs.get_plugin_description
   dissect.target.helpers.docs.get_plugin_overview



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.helpers.docs.NO_DOCS
   dissect.target.helpers.docs.FUNCTION_OUTPUT_DESCRIPTION
   dissect.target.helpers.docs.INDENT_STEP
   dissect.target.helpers.docs.FUNC_DOC_TEMPLATE


.. py:data:: NO_DOCS
   :value: 'No documentation'


.. py:data:: FUNCTION_OUTPUT_DESCRIPTION

.. py:data:: INDENT_STEP
   :value: '    '


.. py:data:: FUNC_DOC_TEMPLATE
   :value: '{func_name} - {short_description} (output: {output_type})'


.. py:function:: get_docstring(obj: Any, placeholder: str = NO_DOCS) -> str

   Get object's docstring or a placeholder if no docstring found.


.. py:function:: get_func_description(func: collections.abc.Callable, with_docstrings: bool = False) -> str

.. py:function:: get_plugin_functions_desc(plugin_class: type[dissect.target.plugin.Plugin], with_docstrings: bool = False) -> str

.. py:function:: get_plugin_description(plugin_class: type[dissect.target.plugin.Plugin]) -> str

.. py:function:: get_plugin_overview(plugin_class: type[dissect.target.plugin.Plugin], with_plugin_desc: bool = False, with_func_docstrings: bool = False) -> str