Add documentation and host it at readthedocs.org

stefanfoulis / django-phonenumber-field

A django model and form field for normalised phone numbers using python-phonenumbers

MIT License

1.49k stars 315 forks source link

Add documentation and host it at readthedocs.org #531

Closed francoisfreitag closed 2 years ago

francoisfreitag commented 2 years ago

The documentation is built with Sphinx, and hosted on readthedocs.org. The README was stripped to its bare minimum, and now points to the documentation. Code excerpt are verified with doctest.

Fixes #52 Fixes #152 Refs #224

francoisfreitag commented 2 years ago

Can see the builds on my fork, e.g. https://django-phonenumber-field--1.org.readthedocs.build/en/1/

This PR includes the changes from https://github.com/stefanfoulis/django-phonenumber-field/pull/529, because I had already written the documentation for it. If #529 end up being controversial, I’ll pull its changes out of this PR.