index.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. .. django-extensions documentation master file, created by
  2. sphinx-quickstart on Wed Apr 1 20:39:40 2009.
  3. You can adapt this file completely to your liking, but it should at least
  4. contain the root `toctree` directive.
  5. Welcome to the django-extensions documentation!
  6. ===============================================
  7. Django Extensions is a collection of custom extensions for the Django Framework.
  8. These include management commands, additional database fields, admin extensions and
  9. much more.
  10. `这篇文档当然还有中文版 <https://django-extensions-zh.readthedocs.io/zh_CN/latest/>`_
  11. Getting Started
  12. ===============
  13. The easiest way to figure out what Django Extensions are all about is to watch the `excellent screencast by Eric Holscher`__. In a couple minutes Eric walks you through a half a dozen command extensions.
  14. Getting it
  15. ==========
  16. You can get Django Extensions by using pip or easy_install::
  17. $ pip install django-extensions
  18. or
  19. $ easy_install django-extensions
  20. If you want to install it from source, grab the git repository and run setup.py::
  21. $ git clone git://github.com/django-extensions/django-extensions.git
  22. $ cd django-extensions
  23. $ python setup.py install
  24. For more detailed instructions check out our :doc:`installation_instructions`. Enjoy.
  25. Compatibility with versions of Python and Django
  26. =================================================
  27. We follow the Django guidelines for supported Python and Django versions. See more at `Django Supported Versions <https://docs.djangoproject.com/en/dev/internals/release-process/#supported-versions>`_
  28. This might mean the django-extensions may work with older or unsupported versions but we do not guarantee it and most likely will not fix bugs related to incompatibilities with older versions.
  29. At this time we test on and thrive to support valid combinations of Python 2.7, 3.4, 3.5, pypy and pypy3 with Django versions 1.8 and 1.9.
  30. Contents
  31. ========
  32. .. toctree::
  33. :maxdepth: 3
  34. installation_instructions
  35. command_extensions
  36. command_extension_ideas
  37. command_signals
  38. admin_extensions
  39. shell_plus
  40. create_app
  41. delete_squashed_migrations
  42. dumpscript
  43. runscript
  44. export_emails
  45. field_extensions
  46. graph_models
  47. jobs_scheduling
  48. model_extensions
  49. namespace_proposal
  50. print_settings
  51. runprofileserver
  52. runserver_plus
  53. sync_s3
  54. sqldiff
  55. sqlcreate
  56. sqldsn
  57. validate_templates
  58. Indices and tables
  59. ==================
  60. * :ref:`search`
  61. __ http://ericholscher.com/blog/2008/sep/12/screencast-django-command-extensions/