Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Fern sponsor message #2309

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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

Example
=======

.. code-block:: python

from datetime import date
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;
}
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ marshmallow: simplified object serialization

Release v\ |version|. (:doc:`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

.. include:: about.rst.inc

Upgrading from an older version?
Expand Down