.. raw:: html
.. You can adapt this file completely to your liking, but it should at least
.. contain the root `toctree` directive.
.. Custom roles and commands
.. |_| unicode:: U+00A0 .. non-breaking space
.. |manual| image:: _static/img/user-manual.png
.. |api| image:: _static/img/api-2.png
.. |python| image:: _static/img/python.png
.. |package| image:: _static/img/package.png
.. |pipeline| image:: _static/img/pipeline.png
.. |changelog| image:: _static/img/changelog.png
.. role:: blue
Welcome to the api-24sea-ai project documentation!
====================================================================================================================================================
.. topic:: Release Dev
Version |release|
**api-24sea-ai** is an extension package for `API-24SEA `_
that provides tools to interact with the AI models hosted on the 24SEA platform.
.. note::
Some pages have been protected with a master password. If you are
interested in accessing them, please contact 24SEA at
`support.api@24sea.eu `_, and we will
see what we can do 😊.
-----------------------
.. grid:: 1 2 2 2
:gutter: 3 3 4 5
.. grid-item-card::
|manual| |_| |_| |_| |_| **Quick start!**
New to api_24sea? Check out the Quick Start guide
+++
.. button-ref:: project/01-intro
:expand:
:color: primary
:click-parent:
To the Quick Start guide
.. grid-item-card::
|api| |_| |_| |_| |_| **24SEA Endpoints**
The user guide provides in-depth documentation on the 24SEA API
endpoints for data retrieval.
+++
.. button-link:: https://api.24sea.eu/docs/v1#tag/AI
:expand:
:color: primary
:click-parent:
To the 24SEA API Endpoints Documentation AI section
.. grid-item-card::
|package| |_| |_| |_| |_| **Package Reference**
The package reference documentation contains a detailed code description
of api_24sea.
+++
.. button-ref:: autoapi/index
:expand:
:color: primary
:click-parent:
To the reference guide
.. grid-item-card::
|changelog| |_| |_| |_| |_| **Changelog**
Release notes and changelog for all versions of the package.
+++
.. button-ref:: project/02-changelog
:expand:
:color: primary
:click-parent:
To the changelog
.. grid:: 1
.. grid-item-card::
|python| |_| |_| |_| |_| **Interactive Example**
Explore an interactive example to try the package and its AI features directly.
+++
.. button-ref:: project/03-interactive-example
:expand:
:color: primary
:click-parent:
To the interactive example
-----------------------
.. toctree::
:hidden:
project/01-intro
dev-guide/01-intro
autoapi/index
project/02-changelog
project/03-interactive-example
License
-----------------------
The package is licensed under the `GNU General Public License v3.0 `_.
Miscellaneous Pages
-------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`