search

macropin / django-registration

Django-registration (redux) provides user registration functionality for Django websites.
http://django-registration-redux.readthedocs.org
Other
974 stars 348 forks source link

Document default URLs #397

Closed wtracy closed 3 years ago

wtracy commented 4 years ago

This patch adds a new page to the documentation highlighting the actual URLs provided by the various urls.py files. It also adds documentation for a couple of templates not already present in the documentation.

This patch converts the heading for each template from a bold line to a reStructuredText subsubheading. This makes creating deep links cleaner. If you don't like this change, look at commit b664aea.

While most URLs have an associated view and template, some only have one. I've just omitted those sections, but we could explicitly call out those absences.

I'm open to ideas for what to do with the various URLs that reference Django builtin views. We could try to directly hotlink to the Django documentation. These views also come with templates, which I haven't bothered to document here, either.

Finally, there's the extra view and template provided by the admin_approval backend. There's no official documentation to hyperlink here. You might be fine with that, or we might want to create new entries for them.

coveralls commented 4 years ago

Coverage Status

Coverage remained the same at 97.279% when pulling e67e4104dd4f8918943b3d76a9ecce09c2a22d36 on wtracy:documenturls into b66ddb4b0044c5a0f24b6a23d5387f68b6d7e577 on macropin:master.