Skip to content

Commit c406571

Browse files
authored
Update CHANGELOG.md
1 parent d516948 commit c406571

File tree

1 file changed

+53
-33
lines changed

1 file changed

+53
-33
lines changed

CHANGELOG.md

Lines changed: 53 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,127 +5,147 @@ 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+
## [0.1.24] - 17 June 2021
9+
10+
### Added
11+
12+
- [#180](https://github.com/scylladb/sphinx-scylladb-theme/issues/180): Now projects can configure promotional banners.
13+
- [#179](https://github.com/scylladb/sphinx-scylladb-theme/issues/179): Troubleshooting guides for multiversion.
14+
- [#173](https://github.com/scylladb/sphinx-scylladb-theme/issues/173): Dropdown for Contributors with the options to "Report an Issue" and "Learn How to Contribute".
15+
- [#170](https://github.com/scylladb/sphinx-scylladb-theme/issues/170): Option to hide versions from the multiversion dropdown.
16+
- [#174](https://github.com/scylladb/sphinx-scylladb-theme/issues/174): Shared substitutions for all projects.
17+
18+
### Fixed
19+
20+
- [#171](https://github.com/scylladb/sphinx-scylladb-theme/issues/171): Branches name were rendered in ASC order.
21+
22+
### Removed
23+
24+
- [#173](https://github.com/scylladb/sphinx-scylladb-theme/issues/179): Report an issue button from footer.
25+
826
## [0.1.23] - 22 Apr 2021
927

1028
### Removed
1129

12-
- Top-bar for Scylla University live (#152)
30+
- [#152](https://github.com/scylladb/sphinx-scylladb-theme/issues/152): Top-bar for Scylla University live.
1331

1432
## [0.1.22] - 14 Apr 2021
1533

1634
### Added
1735

18-
- Top-bar for Scylla University live (#152)
19-
- Contribution guidelines (#146)
20-
- ``*-substring_removed`` settings in ``conf`` overrides part of the version name in the multiversion dropdown. (#110)
36+
- [#152](https://github.com/scylladb/sphinx-scylladb-theme/issues/152): Top-bar for Scylla University live.
37+
- [#146](https://github.com/scylladb/sphinx-scylladb-theme/issues/146): Guidelines for project maintainers.
38+
- [#110](https://github.com/scylladb/sphinx-scylladb-theme/issues/110): Theme option to override part of the version name in the multiversion dropdown.
2139

2240
### Fixed
2341

24-
- Create intermediate directories for redirections (#153)
42+
- [#153](https://github.com/scylladb/sphinx-scylladb-theme/issues/153): Create intermediate directories for redirections.
2543

2644
## [0.1.21] - 24 Jan 2021
2745

2846
### Added
2947

30-
- ``smv_rename_latest_version`` setting in ``conf.py`` overrides the latest version output directory (#121).
48+
- [#121](https://github.com/scylladb/sphinx-scylladb-theme/issues/121): ``smv_rename_latest_version`` setting in ``conf.py`` overrides the latest version output directory.
3149

3250
### Changed
3351

34-
- Moved ``smv_latest_version`` from ``github/workflows/pages.yml`` to ``conf.py`` (#121).
52+
- [#121](https://github.com/scylladb/sphinx-scylladb-theme/issues/121): Moved ``smv_latest_version`` from ``github/workflows/pages.yml`` to ``conf.py``.
3553

3654
### Removed
3755

38-
- ``_utils/redirects.sh`` file (#121).
56+
- [#121](https://github.com/scylladb/sphinx-scylladb-theme/issues/121): ``_utils/redirects.sh`` script.
3957

4058
### Fixed
4159

42-
- ``make multiversionpreview`` redirects automatically to the latest version (#121).
43-
60+
- [#121](https://github.com/scylladb/sphinx-scylladb-theme/issues/121): ``make multiversionpreview`` was not redirecting automatically to the latest version.
61+
4462

4563
## [0.1.20] - 19 Jan 2021
4664

4765
### Added
48-
- Unstable version warning (#111).
66+
67+
- [#111](https://github.com/scylladb/sphinx-scylladb-theme/issues/111): Show a warning if the latest version is not stable.
4968

5069
### Changed
5170

52-
- Disable Scylla Summit banner (#106).
53-
- Documentation moved to docs folder (#108).
71+
- [#106](https://github.com/scylladb/sphinx-scylladb-theme/issues/106): Disable Scylla Summit banner (#106).
72+
- [#108](https://github.com/scylladb/sphinx-scylladb-theme/issues/108): Documentation of the project moved under docs folder.
5473

5574
## [0.1.19] - 07 Jan 2021
5675

5776
### Added
5877

59-
- Sphinx and theme version in the footer (#98).
78+
- [#98](https://github.com/scylladb/sphinx-scylladb-theme/issues/98): Show Sphinx & Theme version in the footer.
6079

6180
### Changed
6281

63-
- Show multiversion label always (#100).
82+
- [#100](https://github.com/scylladb/sphinx-scylladb-theme/issues/100): Show the multiversion label when there is only one version.
6483

6584
### Fixed
6685

67-
- Report button when title has inlines (#103).
86+
- [#103](https://github.com/scylladb/sphinx-scylladb-theme/issues/103): Report button does not break when the page title has inlines.
87+
6888

6989
## [0.1.18] - 31 Dec 2020
7090

7191
### Added
7292

73-
- Custom domain support for multiversion builds (#95).
74-
- make multiversionpreview command (#92).
75-
- Stable tag (#89).
93+
- [#84](https://github.com/scylladb/sphinx-scylladb-theme/issues/84): Banner for Scylla Summit.
94+
- [#95](https://github.com/scylladb/sphinx-scylladb-theme/issues/95): Support for custom domain.
95+
- [#92](https://github.com/scylladb/sphinx-scylladb-theme/issues/92): Command to preview multiversion build.
96+
- [#89](https://github.com/scylladb/sphinx-scylladb-theme/issues/89): Rename the latest version URL automatically to stable.
7697

7798
## [0.1.16] - 24 Nov 2020
7899

79100
### Added
80101

81-
- Add Scylla Summit Banner (#84).
102+
- [#84](https://github.com/scylladb/sphinx-scylladb-theme/issues/84): Banner for Scylla Summit.
82103

83104
### Changed
84105

85-
- Update copyright year automatically (#83).
86-
87-
### Fixed
106+
- [#83](https://github.com/scylladb/sphinx-scylladb-theme/issues/83): Copyright year in the footer is now updated automatically.
88107

89-
- Warning when not reading the latest version (#78).
90108

91109
## [0.1.15] - 17 Nov 2020
92110

93111
### Added
94112

95-
- Warning when not reading the latest version (#78).
113+
- [#78](https://github.com/scylladb/sphinx-scylladb-theme/issues/78): Show a warning when the user is not reading not reading the latest version.
96114

97115
## [0.1.14] - 28 Oct 2020
98116

99117
### Changed
100118

101-
- Overwrites the Sphinx classification for external and internal links (#72).
102-
- Description configurable per project (#71).
119+
- [#72](https://github.com/scylladb/sphinx-scylladb-theme/issues/72): Overwrite the Sphinx classification for external and internal links.
120+
- [#71](https://github.com/scylladb/sphinx-scylladb-theme/issues/71): Site description is now configurable per project.
103121

104122
## [0.1.13] - 20 Oct 2020
105123

106124
### Added
107-
- External links and download links are now followed by an icon (#65).
108-
- Code blocks can now include substitutions (#53).
125+
126+
- [#65](https://github.com/scylladb/sphinx-scylladb-theme/issues/65): External links and download links are now followed by an icon.
127+
- [#53](https://github.com/scylladb/sphinx-scylladb-theme/issues/53): Now code blocks can include substitutions.
109128

110129
### Changed
111130

112131
- The 404 page sports a new design (#64)
113132

114133
### Fixed
115134

116-
- Redirections on multiversion builds were not working properly with GitHub Pages (#69)
135+
- [#69](https://github.com/scylladb/sphinx-scylladb-theme/issues/69): Redirections on multiversion builds were not working
117136

118137
### Removed
119138

120-
- pipx dependency (#68)
139+
- [#68](https://github.com/scylladb/sphinx-scylladb-theme/issues/68): PIPX dependency.
121140

122141
## [0.1.12] - 01 Oct 2020
123142

124143
### Added
125144

126-
- The 404 page is now loaded from the theme (#58, #59)
127-
- The redirection scripts are now part of the theme (#58)
145+
- [#59](https://github.com/scylladb/sphinx-scylladb-theme/issues/59): All projects now share a 404 page.
146+
- [#58](https://github.com/scylladb/sphinx-scylladb-theme/issues/58): Support for redirections.
128147

148+
[0.1.24]: https://github.com/scylladb/sphinx-scylladb-theme/compare/0.1.23...0.1.24
129149
[0.1.23]: https://github.com/scylladb/sphinx-scylladb-theme/compare/0.1.22...0.1.23
130150
[0.1.22]: https://github.com/scylladb/sphinx-scylladb-theme/compare/0.1.21...0.1.22
131151
[0.1.21]: https://github.com/scylladb/sphinx-scylladb-theme/compare/0.1.20...0.1.21

0 commit comments

Comments
 (0)