Add documentation and host it at readthedocs.org #531
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
francoisfreitag
force-pushed
the
doc
branch
5 times, most recently
from
0c1204f to
771902d
Compare
francoisfreitag
changed the title
|
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 #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. |
francoisfreitag
force-pushed
the
doc
branch
3 times, most recently
from
99cedae to
de6eca7
Compare
Documentation is hosted on readthedocs.org, it’s free for public open-source project and a popular choice. The Sphinx readthedocs theme was picked for the same reasons. The code examples are verified with doctest. Most documentation for the fields live in the code directly, in an attempt to keep them in sync.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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