Skip to content

Commit 18ff09a

Browse files
committed
Update docs for python 3.6.
1 parent 15b1131 commit 18ff09a

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ Flask-Selfdoc is a Flask extension that automatically creates documentation for
1212

1313
## Requirements
1414

15-
Flask-Selfdoc is compatible with Python versions >=3.6 and Flask versions >=1.0.
15+
Flask-Selfdoc is compatible with Python versions >=3.7 and Flask versions >=1.0.
16+
1617
The package is tested with a selection of those versions. If you find it doesn't work correctly with versions in those ranges please report a bug, thanks.
1718

18-
Previous versions of Flask-Selfdoc worked with Python 2.7, Python 3.5 and Flask 0.11 and 0.12. If you need a version which works with these old versions of Python and Flask, try Flask-Selfdoc 1.2.3 (but you are better off upgrading away from end-of-life Python!!!)
19+
Previous versions of Flask-Selfdoc worked with Python 2.7, Python 3.5 and 3.6 and Flask 0.11 and 0.12. If you need a version which works with these old versions of Python and Flask, try Flask-Selfdoc 1.2.3 (but you are better off upgrading away from end-of-life Python!!!)
1920

2021
## Install
2122

README.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Flask-Selfdoc
33

44
Flask-Selfdoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. It was forked from Flask-Autodoc, written by Arnaud Coomans, and is completely compatible as a replacement for that extension.
55

6-
Flask-Selfdoc is compatible with Python versions 2 and 3; and it depends only on Flask. It is tested with all versions of Flask from 0.11 up to the latest release and the latest Flask release will continue to be supported.
6+
Flask-Selfdoc is compatible with Python versions 3.7 and upwards; and it depends only on Flask. It is tested with all versions of Flask from 1.0 up to the latest release and the latest Flask release will continue to be supported.
77

88
If your codebase uses Flask-Autodoc, you can swap it for Flask-Selfdoc by simply changing the name of the module in your import:
99

@@ -13,6 +13,6 @@ instead of
1313

1414
from flask_autodoc import Autodoc
1515

16-
No other changes are necessary. Flask-Selfdoc 1.0 has exactly the same functionality as Flask-Autodoc 0.1.2, the most recent release at the time of the fork. The projects will remain like-for-like compatible for the foreseeable future.
16+
No other changes are necessary. Flask-Selfdoc 1.x has exactly the same functionality as Flask-Autodoc 0.1.2, the most recent release at the time of the fork. The projects will remain compatible for the foreseeable future, although some functionality will be added to Flask-Selfdoc.
1717

18-
The main project webpage is on GitHub at https://github.com/jwg4/flask-selfdoc and the full documentation is at https://github.com/jwg4/flask-selfdoc/blob/master/README.md
18+
The main project webpage is on GitHub at https://github.com/jwg4/flask-selfdoc and the full documentation is at https://github.com/jwg4/flask-selfdoc/blob/master/README.md

0 commit comments

Comments
 (0)