Skip to content

Commit 430185e

Browse files
committed
docs: add changelog in the documentation
1 parent 13ce932 commit 430185e

File tree

3 files changed

+25
-41
lines changed

3 files changed

+25
-41
lines changed

CHANGES.rst

Lines changed: 20 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,52 @@
1-
Changes
2-
=======
3-
41
Version 0.x
52
-----------
63

74
- Stop support for python 3.6 and 3.7. Start support for python3
8-
3.11 and 3.12. (`#41`)
5+
3.11 and 3.12. (:pr:`41`)
6+
- ``render_kw`` support (:pr:`42`)
7+
- ``optgroup`` support (:pr:`44`)
8+
- SQLAlchemy 2.0 support (:pr:`45`)
99

1010
Version 0.3
1111
-----------
1212

1313
Released on November 6th, 2021
1414

15-
- Wtforms 3 support. (`#35`_)
16-
- SQLAlchemy 1.4 tests fixes. (`#34`_)
17-
- Switched from Travis CI to Github Actions (`#33`_)
18-
- Abandon deperecated validator. (`#32`_)
19-
- Stop support for python < 3.8; start support for python 3.12 (`#41`_)
20-
- ``render_kw`` support (`#42`_)
21-
- ``optgroup`` support (`#44`_)
22-
- SQLAlchemy 2.0 support (`#45`_)
15+
- Wtforms 3 support. (:pr:`35`)
16+
- SQLAlchemy 1.4 tests fixes. (:pr:`34`)
17+
- Switched from Travis CI to Github Actions (:pr:`33`)
18+
- Abandon deperecated validator. (:pr:`32`)
2319

2420
Version 0.2
2521
-----------
2622

2723
Released on June 21st, 2020
2824

2925
- Auto-generated ``DecimalField`` does not limit places for ``Float``
30-
columns. (`#2`_)
31-
- Add an example of using this library with Flask-SQAlchemy. (`#3`_)
26+
columns. (:pr:`2`)
27+
- Add an example of using this library with Flask-SQAlchemy. (:pr:`3`)
3228
- Generating a form from a model copies any lists of validators
3329
passed in ``field_args`` to prevent modifying a shared value across
34-
forms. (`#5`_)
30+
forms. (:pr:`5`)
3531
- Don't add a ``Length`` validator when the column's length is not an
36-
int. (`#6`_)
32+
int. (:pr:`6`)
3733
- Add ``QueryRadioField``, like ``QuerySelectField`` except
3834
it renders a list of radio fields. Add ``QueryCheckboxField``, like
3935
``QuerySelectMultipleField`` except it renders a list of checkbox
40-
fields. (`#8`_)
36+
fields. (:pr:`8`)
4137
- Fix a compatibility issue with SQLAlchemy 2.1 that caused
42-
``QuerySelectField`` to fail with a ``ValueError``. (`#9`_, `#10`_,
43-
`#11`_)
38+
``QuerySelectField`` to fail with a ``ValueError``. (:issue:`9`, :pr:`10`,
39+
:pr:`11`)
4440
- QuerySelectField.query allowing no results instead of falling back to
45-
``query_factory``. (`#15`_)
46-
- Explicitly check if db_session is None in converter. (`#17`_)
41+
``query_factory``. (:pr:`15`)
42+
- Explicitly check if db_session is None in converter. (:pr:`17`)
4743
- Check for ``sqlalchemy.`` to avoid matching packages with names starting
4844
with ``sqlalchemy`` (6237a0f_)
49-
- Use SQLAlchemy's Column.doc for WTForm's Field.description (`#21`_)
50-
- Stopped support for python < 3.5 and added a style pre-commit hook. (`#23`_)
51-
- Documentation cleanup. (`#24`_)
45+
- Use SQLAlchemy's Column.doc for WTForm's Field.description (:pr:`21`)
46+
- Stopped support for python < 3.5 and added a style pre-commit hook. (:pr:`23`)
47+
- Documentation cleanup. (:pr:`24`)
5248

53-
.. _#2: https://github.com/wtforms/wtforms-sqlalchemy/pull/2
54-
.. _#3: https://github.com/wtforms/wtforms-sqlalchemy/pull/3
55-
.. _#5: https://github.com/wtforms/wtforms-sqlalchemy/pull/5
56-
.. _#6: https://github.com/wtforms/wtforms-sqlalchemy/pull/6
57-
.. _#8: https://github.com/wtforms/wtforms-sqlalchemy/pull/8
58-
.. _#9: https://github.com/wtforms/wtforms-sqlalchemy/issues/9
59-
.. _#10: https://github.com/wtforms/wtforms-sqlalchemy/pull/10
60-
.. _#11: https://github.com/wtforms/wtforms-sqlalchemy/pull/11
61-
.. _#15: https://github.com/wtforms/wtforms-sqlalchemy/pull/15
62-
.. _#17: https://github.com/wtforms/wtforms-sqlalchemy/pull/17
6349
.. _6237a0f: https://github.com/wtforms/wtforms-sqlalchemy/commit/6237a0f9e53ec5f22048be7f129e29f7f1c58448
64-
.. _#21: https://github.com/wtforms/wtforms-sqlalchemy/pull/21
65-
.. _#23: https://github.com/wtforms/wtforms-sqlalchemy/pull/23
66-
.. _#24: https://github.com/wtforms/wtforms-sqlalchemy/pull/24
67-
.. _#32: https://github.com/wtforms/wtforms-sqlalchemy/pull/32
68-
.. _#33: https://github.com/wtforms/wtforms-sqlalchemy/pull/33
69-
.. _#34: https://github.com/wtforms/wtforms-sqlalchemy/pull/34
70-
.. _#35: https://github.com/wtforms/wtforms-sqlalchemy/pull/35
7150

7251
Version 0.1
7352
-----------

docs/changes.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Changes
2+
=======
3+
4+
.. include:: ../CHANGES.rst

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Contents:
1212
:maxdepth: 2
1313

1414
wtforms_sqlalchemy
15+
changes
1516

1617

1718
Indices and tables

0 commit comments

Comments
 (0)