Skip to content

Commit

Permalink
Merge pull request #688 from marshmallow-code/fern_sponsor
Browse files Browse the repository at this point in the history
Add Fern sponsor message
  • Loading branch information
lafrech authored Oct 1, 2024
2 parents 92f7724 + 8f943da commit 39adb09
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,19 @@ flask-smorest
built upon `Flask <https://palletsprojects.com/p/flask/>`_ and
`marshmallow <https://github.com/marshmallow-code/marshmallow>`_.

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 <https://form.typeform.com/to/bShdJw7z>`_.

.. image:: https://github.com/user-attachments/assets/551997da-6d0c-4d73-85f3-6fb1240e9635
:target: https://form.typeform.com/to/bShdJw7z
:align: center
:alt: Fern logo

Features
========

- Serialization, deserialization and validation using marshmallow ``Schema``
- Explicit validation error messages returned in response
- Database-agnostic
Expand Down
15 changes: 15 additions & 0 deletions docs/_static/css/sponsor-message.css
Original file line number Diff line number Diff line change
@@ -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;
}
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@
# -- Options for HTML output -------------------------------------------------

html_theme = "alabaster"

html_theme_options = {
"description": "Build a REST API on Flask using Marshmallow",
"description_font_style": "italic",
Expand All @@ -98,7 +97,8 @@
"flask-smorest@GitHub": "http://github.com/marshmallow-code/flask-smorest",
},
}

html_static_path = ["_static"]
html_css_files = ["css/sponsor-message.css"]
html_sidebars = {
"**": ["about.html", "donate.html", "navigation.html", "searchbox.html"],
}
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ flask-smorest: Flask/Marshmallow-based REST API framework

Release v\ |version|. (:ref:`Changelog <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 <https://form.typeform.com/to/bShdJw7z>`_.

.. image:: https://github.com/user-attachments/assets/551997da-6d0c-4d73-85f3-6fb1240e9635
:target: https://form.typeform.com/to/bShdJw7z
:align: center
:alt: Fern logo

**flask-smorest** (formerly known as flask-rest-api) is a database-agnostic
framework library for creating REST APIs.

Expand Down

0 comments on commit 39adb09

Please sign in to comment.