.. _Generate Documentation:

Generate Documentation
----------------------

.. code-block:: console

    verissimo.sh <DOC ARGS> [<RULESET FILTER ARGS>] [<LIST UNUSED AVAILABLE RULES ARGS>]

Arguments Description
~~~~~~~~~~~~~~~~~~~~~

.. include:: doc-args.rst

.. include:: ruleset-args.rst

.. include:: ruleset-filter-args.rst

.. include:: list-unused-available-rules-args.rst

Examples
~~~~~~~~

-  Generate the HTML documentation of all the available rules:

.. code-block::

    verissimo.sh -gen_rulepool_doc

-  Generate the HTML documentation for a specific ruleset:

.. code-block:: 

    verissimo.sh -gen_ruleset_doc -ruleset my_ruleset.xml