===========================
inspect-jitsi documentation
===========================

inspect-jitsi inspects a running `Jitsi Meet <https://jitsi.org/>`_ deployment - e.g. counting the participants in a room from its URL - without a browser.

.. grid:: 1 1 2 2
    :gutter: 3 3 4 5

    .. grid-item-card::
        :link: installation
        :link-type: doc

        :octicon:`desktop-download;1.5em;sd-text-info`
        Installation
        ^^^
        Install the ``inspect-jitsi`` command or the Python package.
        +++

        .. button-ref:: installation
            :ref-type: doc
            :color: primary
            :expand:

            Go to Installation

    .. grid-item-card::
        :link: how-to/index
        :link-type: doc

        :octicon:`checklist;1.5em;sd-text-info`
        How-to
        ^^^
        Task-oriented guides, e.g. checking a conference from the command line.
        +++

        .. button-ref:: how-to/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to How-to

    .. grid-item-card::
        :link: development/index
        :link-type: doc

        :octicon:`code;1.5em;sd-text-info`
        Development
        ^^^
        Set up a local development environment and contribute changes.
        +++

        .. button-ref:: development/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Development

    .. grid-item-card::
        :link: reference/index
        :link-type: doc

        :octicon:`bookmark;1.5em;sd-text-info`
        Reference
        ^^^
        CLI, Python API, and changelog.
        +++

        .. button-ref:: reference/index
            :ref-type: doc
            :color: primary
            :expand:

            Go to Reference

.. toctree::
    :hidden:

    installation
    how-to/index
    development/index
    reference/index

-   :ref:`genindex`

Related projects
----------------
`matrix-jitsi-bot <https://matrix-jitsi-bot.readthedocs.io/>`_ - watches Jitsi conferences and reports their status to Matrix chat rooms.

License
-------
See `LICENSE <https://github.com/niccokunzmann/inspect-jitsi/blob/main/LICENSE>`_.