Docs: Updated docs for first publish

Author: Seluj78

.github/workflows/preview-docs.yml

@@ -3,9 +3,9 @@ name: Read the Docs PR preview
 # to the documentation's preview on Read the Docs.
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request_target:
+    types:
+      - opened
     paths:
     - 'docs/**'
     - '.github/workflows/preview-docs.yml'

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+docs/source/generated/

docs/source/generated/flask_utils.rst

@@ -1,10 +1,7 @@
-Welcome to Lumache's documentation!
+Welcome to Flask-Util's documentation!
 ===================================
 
-**Lumache** (/lu'make/) is a Python library 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.
+**Flask Utils** is a Python library that contains a bunch of useful utilities for Flask applications.
 
 Check out the :doc:`usage` section for further information, including
 how to :ref:`installation` the project.

docs/source/index.rst

@@ -10,24 +10,8 @@ To use Lumache, first install it using pip:
 
 .. code-block:: console
 
-   (.venv) $ pip install lumache
+   (.venv) $ pip install flask-utils
 
-Creating recipes
-----------------
+.. note::
 
-To retrieve a list of random ingredients,
-you can use the ``lumache.get_random_ingredients()`` function:
-
-.. autofunction:: flask_utils.register_error_handlers
-
-The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
-or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
-will raise an exception.
-
-.. autoexception:: flask_utils.NotFoundError
-
-For example:
-
->>> import lumache
->>> lumache.get_random_ingredients()
-['shells', 'gorgonzola', 'parsley']
+   I am working on getting this package on PyPI. For now, you can install it through git