Skip to content

Commit 9edcf4b

Browse files
authored
Release 1.4.1 (#721)
* Fix broken link * Release 1.4.1
1 parent 8a1877c commit 9edcf4b

File tree

5 files changed

+152
-116
lines changed

5 files changed

+152
-116
lines changed

docs/source/upgrade/1-3-to-1-4.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Migrating from 1.3 to 1.4
2+
=========================
3+
4+
This guide explains how to upgrade the version of the ScyllaDB Sphinx Theme.
5+
6+
How to check your current theme version
7+
---------------------------------------
8+
9+
The theme version is displayed in the footer of the project's documentation site.
10+
11+
.. image:: version.png
12+
13+
If your project theme's version is **>=1.3**, follow this guide to get the latest version.
14+
15+
Upgrade to version 1.4
16+
----------------------
17+
18+
Here are the main breaking changes between the 1.3 and 1.4 versions.
19+
20+
#. Update the following Python dependencies in ``docs/pyproject.toml``:
21+
22+
.. code-block::
23+
24+
sphinx-scylladb-theme = "~1.4.1"
25+
26+
#. Build the docs locally:
27+
28+
.. code-block::
29+
30+
cd docs
31+
make preview
32+
33+
#. Fix any warnings that appear in the terminal.

docs/source/upgrade/CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## 1.4.1 - 13 March 2023
9+
10+
**IMPORTANT**: For more information on how to update, see [Migrating from 1.3 to 1.4](https://sphinx-theme.scylladb.com/stable/upgrade/1-3-to-1-4.html).
11+
12+
### Added
13+
14+
- [#652](https://github.com/scylladb/sphinx-scylladb-theme/pull/652): The docs builds now raises a warning if a RST or MD file has underscores in the filename.
15+
- [#696](https://github.com/scylladb/sphinx-scylladb-theme/pull/696): The announcement banner can be managed from Google Tag Manager.
16+
17+
### Fixed
18+
19+
- [#720](https://github.com/scylladb/sphinx-scylladb-theme/pull/720): In 1.3.5, we introduced a bug that caused some breadcrumbs to not have a link. This is now fixed.
20+
821
## 1.3.5 - 24 Feb 2023
922

1023
### Updated
@@ -54,6 +67,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
5467

5568
## 1.3.1 - 19 Aug 2022
5669

70+
**IMPORTANT**: For more information on how to update, see [Migrating from 1.2 to 1.3](https://sphinx-theme.scylladb.com/stable/upgrade/1-2-to-1-3.html).
71+
5772
### Added
5873

5974
- [#525](https://github.com/scylladb/sphinx-scylladb-theme/issues/525): When a user clicks on **Create an issue** button, the issue is now created with the prefix `docs:` and the label `documentation`.

docs/source/upgrade/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Upgrade guides
55
:maxdepth: 2
66
:hidden:
77

8+
1-3-to-1-4
89
1-2-to-1-3
910
1-1-to-1-2
1011
1-0-to-1-1
@@ -13,6 +14,7 @@ Upgrade guides
1314

1415
.. panel-box::
1516

17+
* :doc:`Migrating from 1.3 to 1.4 <1-3-to-1-4>`
1618
* :doc:`Migrating from 1.2 to 1.3 <1-2-to-1-3>`
1719
* :doc:`Migrating from 1.1 to 1.2 <1-1-to-1-2>`
1820
* :doc:`Migrating from 1.0 to 1.1 <1-0-to-1-1>`

0 commit comments

Comments
 (0)