Merge pull request #1506 from burnash/doc/community_addons_orm_package

Doc/community addons orm package
burnash · Aug 21, 2024 · 86a75a8 · 86a75a8
2 parents 60bc77f + 944418a
commit 86a75a8
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 5 deletions.
diff --git a/docs/community.rst b/docs/community.rst
@@ -0,0 +1,30 @@
+Community Extensions
+====================
+
+.. _gspread-formating-label:
+
+gspread-formating
+~~~~~~~~~~~~~~~~~
+
+`gspread-formatting <https://github.com/robin900/gspread-formatting>`_ offers extensive functionality to help you when you go beyond basic format
+provided by ``gspread``.
+
+
+.. _gspread-pandas-label:
+
+Using gspread with pandas
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can find the below libraries to use gsrpead with pandas:
+
+ * `gspread-pandas <https://github.com/aiguofer/gspread-pandas>`_
+ * `gspread-dataframe <https://github.com/robin900/gspread-dataframe>`_
+
+.. _gspread-orm-label:
+
+Object Relational Mappers (ORMs)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The `gspread-models <https://github.com/s2t2/gspread-models-py>`_ package provides a straightforward and intuitive model-based
+query interface, making it easy to interact with Google Sheets as if it were more like a database.
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -70,6 +70,14 @@ Advanced
 
     advanced
 
+Community extensions
+--------------------
+
+.. toctree::
+    :maxdepth: 2
+
+    community
+
 
 API Documentation
 ---------------------------

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
@@ -390,7 +390,7 @@ Color the background of **A2:B2** cell range in black, change horizontal alignme
 The second argument to :meth:`~gspread.models.Worksheet.format` is a dictionary containing the fields to update. A full specification of format options is available at `CellFormat <https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#cellformat>`_ in Sheet API Reference.
 
 .. Tip::
-    `gspread-formatting <https://github.com/robin900/gspread-formatting>`_ offers extensive functionality to help you when you go beyond basics.
+    for more complex formatting see :ref:`gspread-formating-label`.
 
 
 Using gspread with pandas
@@ -412,10 +412,7 @@ Here's a basic example for writing a dataframe to a sheet. With :meth:`~gspread.
 
    worksheet.update([dataframe.columns.values.tolist()] + dataframe.values.tolist())
 
-For advanced pandas use cases check out these libraries:
-
- * `gspread-pandas <https://github.com/aiguofer/gspread-pandas>`_
- * `gspread-dataframe <https://github.com/robin900/gspread-dataframe>`_
+For advanced pandas use cases check out community section :ref:`gspread-pandas-label`
 
 Using gspread with NumPy
 ~~~~~~~~~~~~~~~~~~~~~~~~