.. term-image documentation master file
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Term-Image's documentation!
======================================

.. attention::
   🚧 Under Construction - There might be incompatible changes between minor
   versions of `version zero <https://semver.org/spec/v2.0.0.html#spec-item-4>`_!

   If you want to use this library in a project while it's still on version zero,
   ensure you pin the dependency to a specific minor version e.g ``>=0.4,<0.5``.

   On this note, you probably also want to switch to the specific documentation for the
   version you're using (somewhere at the lower left corner of this page).


Contents
--------

.. toctree::
   :maxdepth: 2

   start/index
   guide/index
   api/index
   planned
   issues
   faqs
   glossary


Indices and Tables
------------------

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


.. sidebar-links::
   :caption: External Links
   :github:
   :pypi: term-image

   Changelog <https://github.com/AnonymouX47/term-image/blob/main/CHANGELOG.md>
   Contribution Guide <https://github.com/AnonymouX47/term-image/blob/main/CONTRIBUTING.md>
   License <https://github.com/AnonymouX47/term-image/blob/main/LICENSE>
