Skip to content

Commit

Permalink
docs: Add semver to calver banner (#1699)
Browse files Browse the repository at this point in the history
All Merlin projects are switching from semantic versioning,
like `0.4.0`, to calendar versioning, like `23.01`.
The change is planned for January 2023.
Temporarily add a banner to all pages to prepare
our consumers for the change.
  • Loading branch information
mikemckiernan authored Nov 18, 2022
1 parent ba4c141 commit 21117cf
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.wy-nav-content {
margin: 0;
background: #fcfcfc;
padding-top: 40px;
}

.wy-side-nav-search {
display: block;
width: 300px;
padding: .809em;
padding-top: 0.809em;
margin-bottom: .809em;
z-index: 200;
background-color: #2980b9;
text-align: center;
color: #fcfcfc;
padding-top: 40px;
}

div.banner {
position: fixed;
top: 10px;
left: 20px;
margin: 0;
z-index: 1000;
width: 1050px;
text-align: center;
}

p.banner {
border-radius: 4px;
color: #004831;
background: #76b900;
}
9 changes: 9 additions & 0 deletions docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{% extends "!layout.html" %}
{% block extrabody %}
<div class="banner">
<p class="banner">
Beginning in January 2023, versions for all NVIDIA Merlin projects
will change from semantic versioning like <code>4.0</code>
to calendar versioning like <code>23.01</code>.</p>
</div>
{% endblock %}
3 changes: 2 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
html_static_path = ["_static"]
html_css_files = ["css/custom.css"]

source_suffix = [".rst", ".md"]

Expand Down

0 comments on commit 21117cf

Please sign in to comment.