Example documentation
=====================

One of the great things about defopt is that the same docstrings it uses to
parse arguments are consumed by other tools in the Python ecosystem.

This is the documentation generated by Sphinx for the examples_. You can click
the "Show Source" button to see the raw RST document that generated this page.

Annotations
-----------

.. automodule:: examples.annotations
    :members:
    :undoc-members:
    :show-inheritance:

Boolean flags
-------------

.. automodule:: examples.booleans
    :members:
    :undoc-members:
    :show-inheritance:

Choices
-------

.. automodule:: examples.choices
    :members:
    :undoc-members:
    :show-inheritance:

Exceptions
----------

.. automodule:: examples.exceptions
    :members:
    :undoc-members:
    :show-inheritance:

Lists
-----

.. automodule:: examples.lists
    :members:
    :undoc-members:
    :show-inheritance:

Parsers
-------

.. automodule:: examples.parsers
    :members:
    :undoc-members:
    :show-inheritance:

Short flags
-----------

.. automodule:: examples.short
    :members:
    :undoc-members:
    :show-inheritance:

Variable positional arguments
-----------------------------

.. automodule:: examples.starargs
    :members:
    :undoc-members:
    :show-inheritance:

Docstring styles
----------------

.. automodule:: examples.styles
    :members:
    :undoc-members:
    :show-inheritance:

Nested subcommands
------------------

.. automodule:: examples.nested
    :members:
    :undoc-members:
    :show-inheritance:

.. _examples: https://github.com/anntzer/defopt/tree/main/examples