Skip to content

Commit 8e2c1b8

Browse files
committed
doc: include the readme in the documentation
1 parent e0afb2f commit 8e2c1b8

2 files changed

Lines changed: 7 additions & 9 deletions

File tree

README.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@ WTForms-SQLAlchemy is a fork of the ``wtforms.ext.sqlalchemy`` package from WTFo
1010
The package has been renamed to ``wtforms_sqlalchemy`` but otherwise should
1111
function the same as ``wtforms.ext.sqlalchemy`` did.
1212

13-
to install::
13+
To install::
1414

1515
pip install WTForms-SQLAlchemy
1616

17-
An example using Flask is included in ``examples/flask``.
17+
An example using Flask is included in `examples/flask <https://github.com/pallets-eco/wtforms-sqlalchemy/tree/main/examples/flask>`__.
1818

1919
Features
2020
--------
2121

2222
1. Provide ``SelectField`` integration with SQLAlchemy models
2323

24-
- ``wtforms_sqlalchemy.fields.QuerySelectField``
25-
- ``wtforms_sqlalchemy.fields.QuerySelectMultipleField``
24+
- :class:`wtforms_sqlalchemy.fields.QuerySelectField`
25+
- :class:`wtforms_sqlalchemy.fields.QuerySelectMultipleField`
2626

2727
2. Generate forms from SQLAlchemy models using
28-
``wtforms_sqlalchemy.orm.model_form``
28+
:func:`wtforms_sqlalchemy.orm.model_form`
2929

3030
Rationale
3131
---------

docs/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,11 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
WTForms-SQLAlchemy documentation
7-
================================
8-
9-
Contents:
6+
.. include:: ../README.rst
107

118
.. toctree::
129
:maxdepth: 2
10+
:caption: Contents:
1311

1412
wtforms_sqlalchemy
1513
changes

0 commit comments

Comments
 (0)