sdelements/django-security

Documentation seems to be broken

kravietz opened this issue · 3 comments

Django-security documentation at http://django-security.readthedocs.org/en/latest/ seems to be broken (empty).

As far as I can tell from my own testing, the documentation is fine.

What appears to be "broken" is that Read The Docs hasn't been updated. This is a 'push' action, in that RTD must be updated each time the code is updated, it doesn't see updates automatically.

However, a webhook can be set up in the settings for this project to automatically trigger a rebuild of the documentation on RTD. I suggest that a project admin does this as it will keep the documentation in sync automatically.

https://read-the-docs.readthedocs.org/en/latest/webhooks.html#github

@danpalmer thanks for the tip. I've set up a web hook, so hopefully it'll start picking up on changes. Need to double check how it's configured over at readthedocs, since latest is empty and 0.1.15b has actual content.

This looks to be working.