Skip to content

Commit

Permalink
Add announcement banner to the docs to warn for upcoming v5 breaking …
Browse files Browse the repository at this point in the history
…changes (#702)

* add announcement

* change msg

---------

Co-authored-by: Boisselet Alexandre (IFAT DC ATV SC D TE2) <Alexandre.Boisselet@infineon.com>
Co-authored-by: mortner <magpylib@gmail.com>
  • Loading branch information
3 people committed Dec 22, 2023
1 parent d1bfd12 commit 9413f22
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,14 @@ def setup(app):
# further. For a list of options available for each theme, see the
# documentation.
#

announcement = """
<p>⚠️ <b>Upcoming Soon: New Version 5 with breaking changes. We recommended to pin your dependencies to magpylib>=4.5<5 to avoid breaking changes!
<a href="https://github.com/magpylib/magpylib/discussions/647">(see details)</a>
⚠️</b></p>
"""
html_theme_options = {
"announcement": announcement,
"repository_url": "https://github.com/magpylib/magpylib",
"path_to_docs": "docs/",
"repository_branch": release,
Expand Down

0 comments on commit 9413f22

Please sign in to comment.