diff --git a/README.rst b/README.rst index 7a72b03ec..9a2e04ccc 100644 --- a/README.rst +++ b/README.rst @@ -22,6 +22,19 @@ marshmallow: simplified object serialization **marshmallow** is an ORM/ODM/framework-agnostic library for converting complex datatypes, such as objects, to and from native Python datatypes. +Sponsor Message +=============== + +*Input an OpenAPI spec to generate API docs that look as good as Stripe's. Request a preview of your docs on Fern* `here `_. + +.. image:: https://github.com/user-attachments/assets/551997da-6d0c-4d73-85f3-6fb1240e9635 + :target: https://form.typeform.com/to/bShdJw7z + :align: center + :alt: Fern logo + +Example +======= + .. code-block:: python from datetime import date diff --git a/docs/_static/css/sponsor-message.css b/docs/_static/css/sponsor-message.css new file mode 100644 index 000000000..0efffa520 --- /dev/null +++ b/docs/_static/css/sponsor-message.css @@ -0,0 +1,15 @@ +/* Override alabaster's admonition styling, which we used for sponsored messages */ + +div.admonition-sponsor-message p.admonition-title { + font-size: 18px; + font-style: normal; +} + +p.admonition-title::after { + content: ""; +} + +div.admonition-sponsor-message p { + font-size: 14px; + font-style: italic; +} diff --git a/docs/conf.py b/docs/conf.py index 8075b137e..5e02fe504 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,7 +36,7 @@ html_theme_path = [alabaster.get_path()] html_theme = "alabaster" html_static_path = ["_static"] -html_css_files = ["css/versionwarning.css"] +html_css_files = ["css/versionwarning.css", "css/sponsor-message.css"] templates_path = ["_templates"] html_show_sourcelink = False diff --git a/docs/index.rst b/docs/index.rst index 0da06a6b1..1b6e50b83 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,15 @@ marshmallow: simplified object serialization Release v\ |version|. (:doc:`Changelog `) +.. admonition:: Sponsor Message + + Input an OpenAPI spec to generate API docs that look as good as Stripe's. Request a preview of your docs on Fern `here `_. + + .. image:: https://github.com/user-attachments/assets/551997da-6d0c-4d73-85f3-6fb1240e9635 + :target: https://form.typeform.com/to/bShdJw7z + :align: center + :alt: Fern logo + .. include:: about.rst.inc Upgrading from an older version?