DRY elevator pitch and sponsors sections of docs (#2747)

marshmallow-code · Jan 10, 2025 · b0e7e28 · b0e7e28
1 parent 83c409d
commit b0e7e28
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 58 deletions.
diff --git a/README.rst b/README.rst
@@ -20,6 +20,8 @@ marshmallow: simplified object serialization
    :target: https://marshmallow.readthedocs.io/
    :alt: Documentation
 
+.. start elevator-pitch
+
 **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes.
 
 .. code-block:: python
@@ -50,7 +52,6 @@ marshmallow: simplified object serialization
     #   'release_date': '1971-12-17',
     #   'title': 'Hunky Dory'}
 
-
 In short, marshmallow schemas can be used to:
 
 - **Validate** input data.
@@ -64,6 +65,8 @@ Get it now
 
     $ pip install -U marshmallow
 
+.. end elevator-pitch
+
 Documentation
 =============
 
@@ -110,6 +113,8 @@ Thank you to all our backers! [`Become a backer`_]
 Sponsors
 --------
 
+.. start sponsors
+
 marshmallow is sponsored by `Route4Me <https://route4me.com>`_.
 
 .. image:: https://github.com/user-attachments/assets/018c2e23-032e-4a11-98da-8b6dc25b9054
@@ -121,6 +126,8 @@ Your logo will be displayed here with a link to your website. [`Become a sponsor
 
 .. _`Become a sponsor`: https://opencollective.com/marshmallow#sponsor
 
+.. end sponsors
+
 Professional Support
 ====================
 

diff --git a/docs/about.rst b/docs/about.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,11 @@ marshmallow: simplified object serialization
 
 Release v\ |version|. (:doc:`Changelog <changelog>`)
 
-.. include:: about.rst
+.. include:: ../README.rst
+    :start-after: .. start elevator-pitch
+    :end-before: .. end elevator-pitch
+
+Ready to get started? Go on to the :doc:`Quickstart tutorial <quickstart>` or check out some :doc:`Examples <examples>`.
 
 Upgrading from an older version?
 ================================
@@ -21,16 +25,9 @@ See :doc:`this document <why>` to learn about what makes marshmallow unique.
 Sponsors
 ========
 
-marshmallow is sponsored by `Route4Me <https://route4me.com>`_.
-
-.. image:: https://github.com/user-attachments/assets/018c2e23-032e-4a11-98da-8b6dc25b9054
-    :target: https://route4me.com
-    :alt: Routing Planner
-
-Support this project by becoming a sponsor (or ask your company to support this project by becoming a sponsor).
-Your logo will be displayed here with a link to your website. [`Become a sponsor`_]
-
-.. _`Become a sponsor`: https://opencollective.com/marshmallow#sponsor
+.. include:: ../README.rst
+    :start-after: .. start sponsors
+    :end-before: .. end sponsors
 
 Guide
 =====