Skip to content

Commit b904a72

Browse files
committed
update docs - better toc for changelog
1 parent 291fa66 commit b904a72

File tree

2 files changed

+35
-33
lines changed

2 files changed

+35
-33
lines changed

CHANGELOG.md

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

88
## [Unreleased]
99

10-
### Added
10+
**Added**
1111

1212
*
1313

14-
### Fixed
14+
**Fixed**
1515

1616
*
1717

1818

1919

20-
## [0.21.1] - 2022-09-03
20+
## [0.21.1] - 2022-01-21
21+
22+
**Added**
2123

22-
### Added
2324
* Use Python 3.11 non-beta in CI (#438 by [@bbc2])
2425
* Modernize variables code (#434 by [@Nougat-Waffle])
2526
* Modernize main.py and parser.py code (#435 by [@Nougat-Waffle])
@@ -28,19 +29,22 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
2829
* Updated License to align with BSD OSI template (#433 by [@lsmith77])
2930

3031

31-
### Fixed
32+
**Fixed**
33+
3234
* Fix Out-of-scope error when "dest" variable is undefined (#413 by [@theGOTOguy])
3335
* Fix IPython test warning about deprecated `magic` (#440 by [@bbc2])
3436
* Fix type hint for dotenv_path var, add StrPath alias (#432 by [@eaf])
3537

3638
## [0.21.0] - 2022-09-03
3739

38-
### Added
40+
**Added**
41+
3942
* CLI: add support for invocations via 'python -m'. (#395 by [@theskumar])
4043
* `load_dotenv` function now returns `False`. (#388 by [@larsks])
4144
* CLI: add --format= option to list command. (#407 by [@sammck])
4245

43-
### Fixed
46+
**Fixed**
47+
4448
* Drop Python 3.5 and 3.6 and upgrade GA (#393 by [@eggplants])
4549
* Use `open` instead of `io.open`. (#389 by [@rabinadk1])
4650
* Improve documentation for variables without a value (#390 by [@bbc2])
@@ -50,38 +54,38 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5054

5155
## [0.20.0] - 2022-03-24
5256

53-
### Added
57+
**Added**
5458

5559
- Add `encoding` (`Optional[str]`) parameter to `get_key`, `set_key` and `unset_key`.
5660
(#379 by [@bbc2])
5761

58-
### Fixed
62+
**Fixed**
5963

6064
- Use dict to specify the `entry_points` parameter of `setuptools.setup` (#376 by
6165
[@mgorny]).
6266
- Don't build universal wheels (#387 by [@bbc2]).
6367

6468
## [0.19.2] - 2021-11-11
6569

66-
### Fixed
70+
**Fixed**
6771

6872
- In `set_key`, add missing newline character before new entry if necessary. (#361 by
6973
[@bbc2])
7074

7175
## [0.19.1] - 2021-08-09
7276

73-
### Added
77+
**Added**
7478

7579
- Add support for Python 3.10. (#359 by [@theskumar])
7680

7781
## [0.19.0] - 2021-07-24
7882

79-
### Changed
83+
**Changed**
8084

8185
- Require Python 3.5 or a later version. Python 2 and 3.4 are no longer supported. (#341
8286
by [@bbc2]).
8387

84-
### Added
88+
**Added**
8589

8690
- The `dotenv_path` argument of `set_key` and `unset_key` now has a type of `Union[str,
8791
os.PathLike]` instead of just `os.PathLike` (#347 by [@bbc2]).
@@ -91,7 +95,7 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
9195

9296
## [0.18.0] - 2021-06-20
9397

94-
### Changed
98+
**Changed**
9599

96100
- Raise `ValueError` if `quote_mode` isn't one of `always`, `auto` or `never` in
97101
`set_key` (#330 by [@bbc2]).
@@ -104,41 +108,41 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
104108

105109
## [0.17.1] - 2021-04-29
106110

107-
### Fixed
111+
**Fixed**
108112

109113
- Fixed tests for build environments relying on `PYTHONPATH` (#318 by [@befeleme]).
110114

111115
## [0.17.0] - 2021-04-02
112116

113-
### Changed
117+
**Changed**
114118

115119
- Make `dotenv get <key>` only show the value, not `key=value` (#313 by [@bbc2]).
116120

117-
### Added
121+
**Added**
118122

119123
- Add `--override`/`--no-override` option to `dotenv run` (#312 by [@zueve] and [@bbc2]).
120124

121125
## [0.16.0] - 2021-03-27
122126

123-
### Changed
127+
**Changed**
124128

125129
- The default value of the `encoding` parameter for `load_dotenv` and `dotenv_values` is
126130
now `"utf-8"` instead of `None` (#306 by [@bbc2]).
127131
- Fix resolution order in variable expansion with `override=False` (#287 by [@bbc2]).
128132

129133
## [0.15.0] - 2020-10-28
130134

131-
### Added
135+
**Added**
132136

133137
- Add `--export` option to `set` to make it prepend the binding with `export` (#270 by
134138
[@jadutter]).
135139

136-
### Changed
140+
**Changed**
137141

138142
- Make `set` command create the `.env` file in the current directory if no `.env` file was
139143
found (#270 by [@jadutter]).
140144

141-
### Fixed
145+
**Fixed**
142146

143147
- Fix potentially empty expanded value for duplicate key (#260 by [@bbc2]).
144148
- Fix import error on Python 3.5.0 and 3.5.1 (#267 by [@gongqingkui]).
@@ -147,54 +151,54 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
147151

148152
## [0.14.0] - 2020-07-03
149153

150-
### Changed
154+
**Changed**
151155

152156
- Privilege definition in file over the environment in variable expansion (#256 by
153157
[@elbehery95]).
154158

155-
### Fixed
159+
**Fixed**
156160

157161
- Improve error message for when file isn't found (#245 by [@snobu]).
158162
- Use HTTPS URL in package meta data (#251 by [@ekohl]).
159163

160164
## [0.13.0] - 2020-04-16
161165

162-
### Added
166+
**Added**
163167

164168
- Add support for a Bash-like default value in variable expansion (#248 by [@bbc2]).
165169

166170
## [0.12.0] - 2020-02-28
167171

168-
### Changed
172+
**Changed**
169173

170174
- Use current working directory to find `.env` when bundled by PyInstaller (#213 by
171175
[@gergelyk]).
172176

173-
### Fixed
177+
**Fixed**
174178

175179
- Fix escaping of quoted values written by `set_key` (#236 by [@bbc2]).
176180
- Fix `dotenv run` crashing on environment variables without values (#237 by [@yannham]).
177181
- Remove warning when last line is empty (#238 by [@bbc2]).
178182

179183
## [0.11.0] - 2020-02-07
180184

181-
### Added
185+
**Added**
182186

183187
- Add `interpolate` argument to `load_dotenv` and `dotenv_values` to disable interpolation
184188
(#232 by [@ulyssessouza]).
185189

186-
### Changed
190+
**Changed**
187191

188192
- Use logging instead of warnings (#231 by [@bbc2]).
189193

190-
### Fixed
194+
**Fixed**
191195

192196
- Fix installation in non-UTF-8 environments (#225 by [@altendky]).
193197
- Fix PyPI classifiers (#228 by [@bbc2]).
194198

195199
## [0.10.5] - 2020-01-19
196200

197-
### Fixed
201+
**Fixed**
198202

199203
- Fix handling of malformed lines and lines without a value (#222 by [@bbc2]):
200204
- Don't print warning when key has no value.
@@ -203,7 +207,7 @@ project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
203207

204208
## [0.10.4] - 2020-01-17
205209

206-
### Added
210+
**Added**
207211

208212
- Make typing optional (#179 by [@techalchemy]).
209213
- Print a warning on malformed line (#211 by [@bbc2]).

mkdocs.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ theme:
1111

1212
markdown_extensions:
1313
- mdx_truly_sane_lists
14-
- toc:
15-
toc_depth: 2
1614

1715
plugins:
1816
- mkdocstrings:

0 commit comments

Comments
 (0)