Welcome to **decree-tree**!
###########################

``decree-tree`` is a package for easily creating nested command-line
interfaces (CLIs) using a class-based syntax. It uses Python's
standard
`argparse <https://docs.python.org/3/library/argparse.html>`__
library and is part of the `Elasmocalc <https://elasmocalc.net>`__
project.

To get started with ``decree-tree``, see the :ref:`quick start guide <start:Quick Start>`.
Here's an example:

.. literalinclude:: code/welcome_example.py
    :language: python
    :lines: 3-

.. FIXME make this example into a test

.. FIXME add a Features section

..
    We use "home_page_in_toc" rather than including ``self`` below.
    Also, not using ``:caption: Contents:``

.. toctree::
    :maxdepth: 2
    :hidden:

    start
    nesting
    configuration
    development
    discussion
    decreetree
    extras
    others
    changelog

Status
******

``decree-tree`` is fairly stable, but still in pre-v1.0 development.

Contributing
************

To contribute, create an issue or submit an MR!

.. FIXME add link to contribution guidelines for decree-tree and/or elasmocalc

Indices and tables
******************

* :doc:`contents`
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Site
****

This documentation site was built with `Sphinx <https://www.sphinx-doc.org/>`__
using the `Sphinx Book Theme <https://sphinx-book-theme.readthedocs.io/>`__
and hosted via `GitLab Pages <https://docs.gitlab.com/ee/user/project/pages/>`__.