File: index.rst

package info (click to toggle)
python-django-treebeard 4.7.1-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 988 kB
  • sloc: python: 5,317; javascript: 258; makefile: 180; sh: 6
file content (71 lines) | stat: -rw-r--r-- 1,210 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
django-treebeard
================

`django-treebeard <https://tabo.pe/projects/django-treebeard/>`_
is a library that implements efficient tree implementations for the
`Django Web Framework 1.8+ <http://www.djangoproject.com/>`_, written by
`Gustavo Picón <https://tabo.pe>`_ and licensed under the Apache License 2.0.

``django-treebeard`` is:

- **Flexible**: Includes 3 different tree implementations with the same API:

  1. :doc:`Adjacency List <al_tree>`
  2. :doc:`Materialized Path <mp_tree>`
  3. :doc:`Nested Sets <ns_tree>`

- **Fast**: Optimized non-naive tree operations
- **Easy**: Uses Django's
  :ref:`model-inheritance` with :ref:`abstract-base-classes`.
  to define your own models.
- **Clean**: Testable and well tested code base. Code/branch test coverage
  is above 96%.


Overview
--------

.. toctree::

   install
   tutorial
   caveats

.. toctree::
   :titlesonly:

   changes

Reference
---------

.. toctree::

   api
   mp_tree
   ns_tree
   al_tree
   exceptions

Additional features
-------------------

.. toctree::

   admin
   forms

Development
-----------

.. toctree::

   tests


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`