maxcountryman / flask-bcrypt

Flask-Bcrypt is a Flask extension that provides bcrypt hashing utilities for your application.

Home Page:http://readthedocs.org/docs/flask-bcrypt/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

update documentation

mjhea0 opened this issue · comments

There's an error in your docs: https://pythonhosted.org/Flask-Bcrypt/#usage

This:

import flask
from flaskext.bcrypt import Bcrypt

app = Flask(__name__)
bcrypt = Bcrypt(app)

Should be:

import flask
from flask.ext.bcrypt import Bcrypt

app = Flask(__name__)
bcrypt = Bcrypt(app)

(missing the "dot" -> flaskext.bcrypt import Bcrypt)

Thanks, did you want to submit a pull request or do you prefer I update it?

I can. It just wasn't clear to me where the docs were. Are they in the zip file -> https://github.com/maxcountryman/flask-bcrypt/tree/master/docs

?

Okay after much trial and tribulation, I have gotten ReadTheDocs to work once again: it turns out the documentation had been updated by a previous commit, but that RTDs was not building it properly due to a git submodule.

At any rate, the new docs are up. Let me know if that fixes the problem.

I don't see it updated here. I tried Google Incognito.

In terms of a google search for flask-bcrypt, the pythonhosted docs show up first. That's updated by pypi, which also references the pythonhosted docs. You should just update pypi as well, especially since you're on version 0.6.1 and pypi references version 0.6 as the latest.

The pythonhosted docs now redirect.

Perfect! 👍