==============
pyyaml-include
==============

.. image:: https://img.shields.io/github/tag/tanbro/pyyaml-include.svg
   :alt: GitHub tag
   :target: https://github.com/tanbro/pyyaml-include

.. image:: https://github.com/tanbro/pyyaml-include/workflows/Python%20package/badge.svg
   :alt: GitHub workflow
   :target: https://github.com/tanbro/pyyaml-include/actions?query=workflow%3A%22Python+package%22

.. image:: https://readthedocs.org/projects/pyyaml-include/badge/?version=latest
   :alt: ReadTheDocs Status
   :target: https://pyyaml-include.readthedocs.io/en/latest/

.. image:: https://img.shields.io/pypi/v/pyyaml-include.svg
   :alt: PyPI
   :target: https://pypi.org/project/pyyaml-include/

.. image:: https://codecov.io/gh/tanbro/pyyaml-include/graph/badge.svg?token=N4QBGv08EE
   :target: https://codecov.io/gh/tanbro/pyyaml-include

.. epigraph::
   `pyyaml-include` is an extending of PyYAML_: include other YAML_ files into YAML_ document.

========== ========= =========
Release    Version   Built at
========== ========= =========
|release|  |version| |today|
========== ========= =========

--------
Contents
--------

.. toctree::
   :caption: Documentation
   :titlesonly:

   README
   CHANGELOG
   AUTHORS

.. toctree::
   :caption: API Reference
   :titlesonly:

   apidoc/modules

------------------
Indices and tables
------------------

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

.. _YAML: http://yaml.org/
.. _PyYaml: https://pyyaml.org/