Welcome to PyGuymer3's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. image:: https://readthedocs.org/projects/pyguymer3/badge/

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/coverage.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/gmake.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/mypy.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/profile.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/publish.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/pylint.yaml/badge.svg

.. image:: https://github.com/Guymer/PyGuymer3/actions/workflows/unittest.yaml/badge.svg

This is a Python 3.X port of
`my Python 2.X module <https://github.com/Guymer/PyGuymer>`_ containing a bunch
of random functions that I have written over the years. The
`module is on PyPI <https://pypi.org/project/PyGuymer3/>`_.

.. include:: installation.rst

.. include:: dependencies.rst

.. include:: testing.rst

.. include:: todo.rst

.. include:: bugs.rst

Module Reference
----------------

Below is the reference documentation for the Python module.

.. autosummary::
   :toctree: _autosummary
   :recursive:

   pyguymer3

Indices And Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`