Skip to content

Commit

Permalink
Update docs for python 3.6.
Browse files Browse the repository at this point in the history
  • Loading branch information
jwg4 committed May 2, 2022
1 parent 15b1131 commit 18ff09a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ Flask-Selfdoc is a Flask extension that automatically creates documentation for

## Requirements

Flask-Selfdoc is compatible with Python versions >=3.6 and Flask versions >=1.0.
Flask-Selfdoc is compatible with Python versions >=3.7 and Flask versions >=1.0.

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.

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!!!)
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!!!)

## Install

Expand Down
6 changes: 3 additions & 3 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Flask-Selfdoc

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.

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.
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.

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

Expand All @@ -13,6 +13,6 @@ instead of

from flask_autodoc import Autodoc

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.
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.

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
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 comments on commit 18ff09a

Please sign in to comment.