index.rst

coincidence

.. documentation-summary::
        :meta:

.. only:: html

        .. list-table::
                :stub-columns: 1
                :widths: 10 90

                * - Docs
                  - |docs| |docs_check|
                * - Tests
                  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
                * - PyPI
                  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
                * - Anaconda
                  - |conda-version| |conda-platform|
                * - Activity
                  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
                * - QA
                  - |codefactor| |actions_flake8| |actions_mypy|
                * - Other
                  - |license| |language| |requires|

        .. |docs| rtfd-shield::
                :project: coincidence
                :alt: Documentation Build Status

        .. |docs_check| actions-shield::
                :workflow: Docs Check
                :alt: Docs Check Status

        .. |actions_linux| actions-shield::
                :workflow: Linux
                :alt: Linux Test Status

        .. |actions_windows| actions-shield::
                :workflow: Windows
                :alt: Windows Test Status

        .. |actions_macos| actions-shield::
                :workflow: macOS
                :alt: macOS Test Status

        .. |actions_flake8| actions-shield::
                :workflow: Flake8
                :alt: Flake8 Status

        .. |actions_mypy| actions-shield::
                :workflow: mypy
                :alt: mypy status

        .. |requires| image:: https://dependency-dash.repo-helper.uk/github/python-coincidence/coincidence/badge.svg
                :target: https://dependency-dash.repo-helper.uk/github/python-coincidence/coincidence/
                :alt: Requirements Status

        .. |coveralls| coveralls-shield::
                :alt: Coverage

        .. |codefactor| codefactor-shield::
                :alt: CodeFactor Grade

        .. |pypi-version| pypi-shield::
                :project: coincidence
                :version:
                :alt: PyPI - Package Version

        .. |supported-versions| pypi-shield::
                :project: coincidence
                :py-versions:
                :alt: PyPI - Supported Python Versions

        .. |supported-implementations| pypi-shield::
                :project: coincidence
                :implementations:
                :alt: PyPI - Supported Implementations

        .. |wheel| pypi-shield::
                :project: coincidence
                :wheel:
                :alt: PyPI - Wheel

        .. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/coincidence?logo=anaconda
                :target: https://anaconda.org/domdfcoding/coincidence
                :alt: Conda - Package Version

        .. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/coincidence?label=conda%7Cplatform
                :target: https://anaconda.org/domdfcoding/coincidence
                :alt: Conda - Platform

        .. |license| github-shield::
                :license:
                :alt: License

        .. |language| github-shield::
                :top-language:
                :alt: GitHub top language

        .. |commits-since| github-shield::
                :commits-since: v0.6.6
                :alt: GitHub commits since tagged version

        .. |commits-latest| github-shield::
                :last-commit:
                :alt: GitHub last commit

        .. |maintained| maintained-shield:: 2024
                :alt: Maintenance

        .. |pypi-downloads| pypi-shield::
                :project: coincidence
                :downloads: month
                :alt: PyPI - Downloads

Installation

.. installation:: coincidence
        :pypi:
        :github:
        :anaconda:
        :conda-channels: conda-forge, domdfcoding

API Reference

.. html-section::

.. toctree::
        :hidden:

        Home<self>

.. toctree::
        :maxdepth: 3
        :glob:

        api/coincidence
        api/*

.. toctree::
        :maxdepth: 2

        changelog

.. sidebar-links::
        :caption: About
        :github:
        :pypi: coincidence

        Contributing Guide <https://contributing-to-coincidence.readthedocs.io/en/latest/>
        Source
        license

.. only:: html

        View the :ref:`Function Index <genindex>` or browse the `Source Code <_modules/index.html>`__.

        :github:repo:`Browse the GitHub Repository <python-coincidence/coincidence>`