Skip to content

Commit 76e8dcc

Browse files
committed
Release notes for ProperDocs 1.6.5
1 parent 2ad739e commit 76e8dcc

File tree

5 files changed

+33
-7
lines changed

5 files changed

+33
-7
lines changed

docs/about/release-notes.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,45 @@ You can determine your currently installed version using `properdocs --version`:
1414

1515
```console
1616
$ properdocs --version
17-
properdocs, version 1.5.0 from /path/to/properdocs (Python 3.10)
17+
properdocs, version 1.6.5 from /path/to/properdocs (Python 3.13)
1818
```
1919

20-
## Maintenance team
20+
## Version 1.6.5 (2026-03-15)
2121

22-
The current and past members of the ProperDocs team.
22+
This is the first version of ProperDocs 🎉
23+
24+
These are the changes compared to MkDocs 1.6.1:
25+
26+
* The name is changed from "ProperDocs" to "MkDocs". The installation name and the executable are `properdocs` (#12)
27+
28+
* Support running all `mkdocs.themes` and `mkdocs.plugins` entrypoints *in addition to* all `properdocs.themes` and `properdocs.plugins` entrypoints (#15)
29+
30+
* Pick up configuration from `properdocs.yml` configuration files, with a fallback to `mkdocs.yml` (#27)
31+
32+
* Remove all built-in themes - there is no longer any theme installed by default (#24)
33+
34+
* Fix livereload not being enabled by default for `mkdocs serve` - since `click>8.2.1` (#14)
35+
36+
* Allow plugins to declare their support of ProperDocs and show a warning message in case they're being run from MkDocs (#21)
37+
38+
* Drop support for Python 3.8, officially support Python 3.14 (#17)
39+
40+
And other small improvements; see [commit log](https://github.com/properdocs/properdocs/compare/2862536793b3c67d9d83c33e0dd6d50a791928f8...1.6.5).
41+
42+
---
43+
44+
## Past releases of MkDocs
45+
46+
Thanks to all the past maintainers of MkDocs!
2347

2448
* [@tomchristie](https://github.com/tomchristie/)
2549
* [@d0ugal](https://github.com/d0ugal/)
2650
* [@waylan](https://github.com/waylan/)
2751
* [@oprypin](https://github.com/oprypin/)
2852
* [@ultrabug](https://github.com/ultrabug/)
2953

54+
The versions below are versions of MkDocs, just for reference.
55+
3056
## Version 1.6.1 (2024-08-30)
3157

3258
### Fixed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '1.6.1'
1+
__version__ = '1.6.5'
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '1.6.1'
1+
__version__ = '1.6.5'

properdocs/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33

44
# For acceptable version formats, see https://www.python.org/dev/peps/pep-0440/
5-
__version__ = '1.6.1'
5+
__version__ = '1.6.5'

properdocs/replacement_warning.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
To avoid these risks, switch to *ProperDocs*, a continuation of MkDocs 1.x and a drop-in replacement that supports your current MkDocs setup.
3232
Simply install it with `pip install properdocs` and build your site with `properdocs build` instead of the MkDocs equivalents.
3333
34-
For more info visit https://github.com/ProperDocs/properdocs/discussions/123 and https://properdocs.org/
34+
For more info visit https://github.com/ProperDocs/properdocs/discussions/456 and https://properdocs.org/
3535
3636
(This warning was initiated by one of the plugins that you depend on.)
3737

0 commit comments

Comments
 (0)