46 lines
1.0 KiB
ReStructuredText
46 lines
1.0 KiB
ReStructuredText
|
.. zxyKit documentation master file, created by
|
||
|
sphinx-quickstart on Thu Apr 20 13:37:44 2023.
|
||
|
You can adapt this file completely to your liking, but it should at least
|
||
|
contain the root `toctree` directive.
|
||
|
|
||
|
Welcome to zxyKit's documentation!
|
||
|
===================================
|
||
|
|
||
|
**Lumache** (/lu'make/) is a Python library yea for cooks and food lovers that
|
||
|
creates recipes mixing random ingredients. It pulls data from the `Open Food
|
||
|
Facts database <https://world.openfoodfacts.org/>`_ and offers a *simple* and
|
||
|
*intuitive* API.
|
||
|
|
||
|
.. note::
|
||
|
|
||
|
This project is under active development.
|
||
|
|
||
|
Contents
|
||
|
--------
|
||
|
.. toctree::
|
||
|
:maxdepth: 2
|
||
|
:caption: Getting Started
|
||
|
|
||
|
getting_started/Quick Start
|
||
|
getting_started/Installation
|
||
|
getting_started/Configuration
|
||
|
getting_started/Examples
|
||
|
|
||
|
|
||
|
.. toctree::
|
||
|
:maxdepth: 2
|
||
|
:caption: Development
|
||
|
|
||
|
development/About
|
||
|
development/Contributing
|
||
|
development/Changelog
|
||
|
|
||
|
|
||
|
|
||
|
Indices and tables
|
||
|
==================
|
||
|
|
||
|
* :ref:`genindex`
|
||
|
* :ref:`modindex`
|
||
|
* :ref:`search`
|