Gustavo Picon is sharing code with you

Bitbucket is a code hosting site. Unlimited public and private repositories. Free for small teams.

Don't show this again

tabo / django-treebeard

Efficient tree implementations for Django 1.0+ :: https://tabo.pe/projects/django-treebeard/

Clone this repository (size: 646.5 KB): HTTPS / SSH 
hg clone https://bitbucket.org/tabo/django-treebeard
hg clone ssh://hg@bitbucket.org/tabo/django-treebeard

django-treebeard / docs / index.rst

Tag
1.5
  • 630024c53f5f
  • 142 loc
  • 3.1 KB
  • embed
  • history
  • annotate
  • raw
  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
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

:mod:`treebeard` --- Efficient tree model implementations for Django
====================================================================

.. automodule:: treebeard

.. automodule:: treebeard.models

   .. autoclass:: Node
      :show-inheritance:

      .. automethod:: add_root
      .. automethod:: add_child
      .. automethod:: add_sibling
      .. automethod:: delete
      .. automethod:: get_tree
      .. automethod:: get_depth
      .. automethod:: get_ancestors
      .. automethod:: get_children
      .. automethod:: get_children_count
      .. automethod:: get_descendants
      .. automethod:: get_descendant_count
      .. automethod:: get_first_child
      .. automethod:: get_last_child
      .. automethod:: get_first_sibling
      .. automethod:: get_last_sibling
      .. automethod:: get_prev_sibling
      .. automethod:: get_next_sibling
      .. automethod:: get_parent
      .. automethod:: get_root
      .. automethod:: get_siblings
      .. automethod:: is_child_of
      .. automethod:: is_descendant_of
      .. automethod:: is_sibling_of
      .. automethod:: is_root
      .. automethod:: is_leaf
      .. automethod:: move
      .. automethod:: save
      .. automethod:: get_first_root_node
      .. automethod:: get_last_root_node
      .. automethod:: get_root_nodes
      .. automethod:: load_bulk
      .. automethod:: dump_bulk
      .. automethod:: find_problems
      .. automethod:: fix_tree
      .. automethod:: get_descendants_group_count


:mod:`treebeard.mp_tree` --- Materialized Path tree
===================================================

.. automodule:: treebeard.mp_tree

   .. autoclass:: MP_Node
      :show-inheritance:

      .. automethod:: add_root

      .. automethod:: add_child
      .. automethod:: add_sibling
      .. automethod:: move

      .. automethod:: get_tree

      .. automethod:: find_problems
      .. automethod:: fix_tree


:mod:`treebeard.al_tree` --- Adjacency List tree
================================================

.. automodule:: treebeard.al_tree

   .. autoclass:: AL_Node
      :show-inheritance:

      .. automethod:: get_depth



:mod:`treebeard.ns_tree` --- Nested Sets tree
=============================================

.. automodule:: treebeard.ns_tree

   .. autoclass:: NS_Node
      :show-inheritance:

      .. automethod:: get_tree


:mod:`treebeard.admin` --- Admin
================================

.. automodule:: treebeard.admin

   .. autoclass:: TreeAdmin



:mod:`treebeard.forms` --- Forms
================================

.. automodule:: treebeard.forms

   .. autoclass:: MoveNodeForm



:mod:`treebeard.exceptions` --- Exceptions
==========================================

.. automodule:: treebeard.exceptions
    
    .. autoexception:: InvalidPosition

    .. autoexception:: InvalidMoveToDescendant

    .. autoexception:: PathOverflow

    .. autoexception:: MissingNodeOrderBy


:mod:`tbbench` --- Benchmarks
=============================

.. automodule:: tbbench


Changes in django-treebeard
===========================

.. include:: ../CHANGES


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

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