mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-11-22 17:47:04 +03:00
Merge pull request #2652 from jpadilla/master
Remove the 'docs for 3.0' banners.
This commit is contained in:
Tom Christie
commit
e520ea0acb
20
README.md
20
README.md
|
|
@ -9,7 +9,9 @@ Full documentation for the project is available at [http://www.django-rest-frame
|
|||
|
||||
---
|
||||
|
||||
**Note**: We have now released Django REST framework 3.0. For older codebases you may want to refer to the version 2.4.4 [source code](https://github.com/tomchristie/django-rest-framework/tree/version-2.4.x), and [documentation](http://tomchristie.github.io/rest-framework-2-docs/).
|
||||
**Note**: We have now released Django REST framework 3.1. For older codebases you may want to refer to the version 2.4.4 [source code](https://github.com/tomchristie/django-rest-framework/tree/version-2.4.x), and [documentation](http://tomchristie.github.io/rest-framework-2-docs/).
|
||||
|
||||
For more details see the [3.1 release notes][3.1-announcement]
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -23,7 +25,7 @@ Some reasons you might want to use REST framework:
|
|||
* [Authentication policies][authentication] including optional packages for [OAuth1a][oauth1-section] and [OAuth2][oauth2-section].
|
||||
* [Serialization][serializers] that supports both [ORM][modelserializer-section] and [non-ORM][serializer-section] data sources.
|
||||
* Customizable all the way down - just use [regular function-based views][functionview-section] if you don't need the [more][generic-views] [powerful][viewsets] [features][routers].
|
||||
* [Extensive documentation][index], and [great community support][group].
|
||||
* [Extensive documentation][docs], and [great community support][group].
|
||||
|
||||
There is a live example API for testing purposes, [available here][sandbox].
|
||||
|
||||
|
|
@ -186,10 +188,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|||
[pypi]: https://pypi.python.org/pypi/djangorestframework
|
||||
[twitter]: https://twitter.com/_tomchristie
|
||||
[group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework
|
||||
[0.4]: https://github.com/tomchristie/django-rest-framework/tree/0.4.X
|
||||
[sandbox]: http://restframework.herokuapp.com/
|
||||
|
||||
[index]: http://www.django-rest-framework.org/
|
||||
[oauth1-section]: http://www.django-rest-framework.org/api-guide/authentication/#django-rest-framework-oauth
|
||||
[oauth2-section]: http://www.django-rest-framework.org/api-guide/authentication/#django-oauth-toolkit
|
||||
[serializer-section]: http://www.django-rest-framework.org/api-guide/serializers/#serializers
|
||||
|
|
@ -200,18 +200,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|||
[routers]: http://www.django-rest-framework.org/api-guide/routers/
|
||||
[serializers]: http://www.django-rest-framework.org/api-guide/serializers/
|
||||
[authentication]: http://www.django-rest-framework.org/api-guide/authentication/
|
||||
[rest-framework-2-announcement]: http://www.django-rest-framework.org/topics/rest-framework-2-announcement/
|
||||
[2.1.0-notes]: https://groups.google.com/d/topic/django-rest-framework/Vv2M0CMY9bg/discussion
|
||||
[image]: http://www.django-rest-framework.org/img/quickstart.png
|
||||
|
||||
[tox]: http://testrun.org/tox/latest/
|
||||
|
||||
[tehjones]: https://twitter.com/tehjones/status/294986071979196416
|
||||
[wlonk]: https://twitter.com/wlonk/status/261689665952833536
|
||||
[laserllama]: https://twitter.com/laserllama/status/328688333750407168
|
||||
|
||||
[docs]: http://www.django-rest-framework.org/
|
||||
[urlobject]: https://github.com/zacharyvoase/urlobject
|
||||
[markdown]: http://pypi.python.org/pypi/Markdown/
|
||||
[django-filter]: http://pypi.python.org/pypi/django-filter
|
||||
[security-mail]: mailto:rest-framework-security@googlegroups.com
|
||||
[3.1-announcement]: http://www.django-rest-framework.org/topics/3.1-announcement/
|
||||
|
|
|
|||
0
docs/api-guide/authentication.md
Executable file → Normal file
0
docs/api-guide/authentication.md
Executable file → Normal file
|
|
@ -1,11 +1,5 @@
|
|||
source: fields.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Serializer fields
|
||||
|
||||
> Each field in a Form class is responsible not only for validating data, but also for "cleaning" it — normalizing it to a consistent format.
|
||||
|
|
|
|||
6
docs/api-guide/generic-views.md
Executable file → Normal file
6
docs/api-guide/generic-views.md
Executable file → Normal file
|
|
@ -1,12 +1,6 @@
|
|||
source: mixins.py
|
||||
generics.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Generic views
|
||||
|
||||
> Django’s generic views... were developed as a shortcut for common usage patterns... They take certain common idioms and patterns found in view development and abstract them so that you can quickly write common views of data without having to repeat yourself.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,5 @@
|
|||
source: metadata.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Metadata
|
||||
|
||||
> [The `OPTIONS`] method allows a client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,5 @@
|
|||
source: relations.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Serializer relations
|
||||
|
||||
> Bad programmers worry about the code.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,5 @@
|
|||
source: request.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Requests
|
||||
|
||||
> If you're doing REST-based web service stuff ... you should ignore request.POST.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,5 @@
|
|||
source: serializers.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Serializers
|
||||
|
||||
> Expanding the usefulness of the serializers is something that we would
|
||||
|
|
|
|||
|
|
@ -1,11 +1,5 @@
|
|||
source: validators.py
|
||||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
---
|
||||
|
||||
# Validators
|
||||
|
||||
> Validators can be useful for re-using validation logic between different types of fields.
|
||||
|
|
|
|||
|
|
@ -9,9 +9,9 @@
|
|||
|
||||
---
|
||||
|
||||
**Note**: This is the documentation for the **version 3.0** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
**Note**: This is the documentation for the **version 3.1** of REST framework. Documentation for [version 2.4](http://tomchristie.github.io/rest-framework-2-docs/) is also available.
|
||||
|
||||
For more details see the [3.0 release notes][3.0-announcement].
|
||||
For more details see the [3.1 release notes][3.1-announcement].
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user