From 11034e22d1b9baa1ee6a20f5d1c3902173940373 Mon Sep 17 00:00:00 2001 From: Gagaro Date: Fri, 13 Jan 2017 12:34:26 +0100 Subject: [PATCH] docs: update docs --- docs/admin.rst | 3 +++ docs/conf.py | 12 +++++++++--- docs/models.rst | 5 +++++ 3 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/admin.rst b/docs/admin.rst index 06a0276..63b064b 100644 --- a/docs/admin.rst +++ b/docs/admin.rst @@ -2,6 +2,9 @@ Handling administration ======================= +Model admin +----------- + .. py:module:: safedelete.admin Deleted objects will also be hidden in the admin site by default. A ``ModelAdmin`` abstract class is provided to give access to deleted objects. diff --git a/docs/conf.py b/docs/conf.py index 920fa0c..ecf074f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -53,9 +53,9 @@ # built documents. # # The short X.Y version. -version = '1' +version = '0.4' # The full version, including alpha/beta/rc tags. -release = '1' +release = '0.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -136,7 +136,13 @@ #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +html_sidebars = { + '**': [ + 'globaltoc.html', + 'relations.html', + 'sourcelink.html', + 'searchbox.html'], +} # Additional templates that should be rendered to pages, maps page names to # template names. diff --git a/docs/models.rst b/docs/models.rst index 3898c11..70a880b 100644 --- a/docs/models.rst +++ b/docs/models.rst @@ -28,6 +28,11 @@ The different policies are: This will make the objects be automatically masked (and not deleted), when you call the delete() method. They will NOT be masked in cascade. +.. py:data:: SOFT_DELETE_CASCADE + + This will make the objects be automatically masked (and not deleted) and all related objects, when you call the delete() method. + They will be masked in cascade. + .. py:data:: HARD_DELETE_NOCASCADE This policy will: