==================================================
``forge`` *(python) signatures for fun and profit*
==================================================

Release v\ |release| (:doc:`What's new? <changelog>`).

.. include:: ../README.rst
    :start-after: overview-begin
    :end-before: overview-end


Installation
============

.. include:: ../README.rst
    :start-after: installation-begin
    :end-before: installation-end


Overview
========

- :doc:`quickstart` is the fastest way to discover ``forge``.
    Start here to forge your first signature.
- :doc:`philosophy` walks you through an example of ``forge`` wrapping the ``stdlib``'s :mod:`logging` module.
    Read this to understand the value proposition, philosphy, and design strategy behind ``forge``.
- :doc:`basic` gives a comprehensive tour of ``forge``'s features.
    Read this to learn how to use ``forge`` - from beginner to advanced features.
- :doc:`advanced` shares some common use-cases and approaches for using ``forge``.
    For example, build a function whose signature changes every call.
- :doc:`api` has documentation for all public functionality.
- :doc:`glossary` helps out iron out semantics and terms that are useful when (re-) designing function signatures.


Full Table of Contents
======================

.. toctree::
    :maxdepth: 2

    quickstart
    philosophy
    basic
    advanced
    api
    glossary
    contributing
    license
    changelog


Indices and tables
==================

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

.. _`hosted on PyPI`: https://pypi.org/project/python-forge
.. _`pip-installing`: https://pip.pypa.io/en/stable/
.. _`virtualenv`: https://docs.python.org/3/library/venv.html

.. include:: ../README.rst
    :start-after: project-information-begin
    :end-before: project-information-end