Merge pull request #9 from TiredFingers/docs

Docs
django-cms · Jul 8, 2021 · eb3fae2 · eb3fae2
2 parents f324378 + 5faabb1
commit eb3fae2
Show file tree

Hide file tree

Showing 173 changed files with 1,851 additions and 7,661 deletions.
diff --git a/docs/topics/frontend-integration.rst → .../advanced-topics/frontend-integration.rst b/docs/topics/frontend-integration.rst → .../advanced-topics/frontend-integration.rst
@@ -1,7 +1,11 @@
-.. _frontend-integration:
+<<<<<<< HEAD:docs/advanced-topics/frontend-integration.rst
+.. _advanced-topics-frontend-integration:
+=======
+.. _frontend:
+>>>>>>> ec1ef18286a802b9046bf6de6c8058a1dadf1ee6:docs/advanced/frontend.rst
 
 ####################
-Frontend integration
+Frontend Integration
 ####################
 
 Generally speaking, django CMS is wholly frontend-agnostic. It doesn't care what your site's
@@ -29,3 +33,4 @@ In such a case, you can use the ``cms-content-refresh`` event to take care of th
     {% endif %}
 
 after the toolbar JavaScript.
+
diff --git a/docs/topics/menu_system.rst → ...nced-topics/how-the-menu-system-works.rst b/docs/topics/menu_system.rst → ...nced-topics/how-the-menu-system-works.rst
@@ -1,5 +1,7 @@
+.. _advanced-topics-how-the-menu-system-works:
+
 #########################
-How the menu system works
+How The Menu System Works
 #########################
 
 **************
@@ -232,3 +234,4 @@ The default Modifiers, in the order they are called, are:
 
     * :py:meth:`~menus.modifiers.Level.mark_levels()` recurses over a node's descendants marking
       their levels
+
diff --git a/docs/how_to/caching.rst → ...advanced-topics/how-to-manage-caching.rst b/docs/how_to/caching.rst → ...advanced-topics/how-to-manage-caching.rst
@@ -1,5 +1,7 @@
+.. _advanced-topics-how-to-manage-caching:
+
 #####################
-How to manage caching
+How To Manage Caching
 #####################
 
 
@@ -56,8 +58,3 @@ Have a look at the following settings to enable/disable various caching behaviou
 - :setting:`CMS_PAGE_CACHE`
 - :setting:`CMS_PLACEHOLDER_CACHE`
 - :setting:`CMS_PLUGIN_CACHE`
-
-
-
-
-
diff --git a/docs/advanced-topics/index.rst b/docs/advanced-topics/index.rst
@@ -0,0 +1,16 @@
+.. _advanced-topics:
+
+###############
+Advanced Topics
+###############
+
+.. toctree::
+    :maxdepth: 1
+
+    how-to-manage-caching
+    how-the-menu-system-works
+    search-in-django-cms
+    permissions
+    using-touch-screen-devices
+    frontend-integration
+    wizard/index
diff --git a/docs/topics/permissions.rst → docs/advanced-topics/permissions.rst b/docs/topics/permissions.rst → docs/advanced-topics/permissions.rst
@@ -1,10 +1,15 @@
+<<<<<<< HEAD:docs/advanced-topics/permissions.rst
+.. _advanced-topics-permissions:
+=======
+..  _permissions:
+>>>>>>> ec1ef18286a802b9046bf6de6c8058a1dadf1ee6:docs/advanced/permissions.rst
+
 ###########
 Permissions
 ###########
 
 The django CMS permissions system is flexible, granular and multi-layered.
 
-
 ****************
 Permission modes
 ****************
@@ -183,3 +188,4 @@ You can divide your users' permissions across two dimensions:
 Groups are very useful for managing this. For example, you can create a *Europe* group for editors
 who are allowed to edit the Europe page hierarchy or sub-site. The group can then be added to a
 :ref:`global or per-page permission <global-and-per-page-permissions>`.
+
diff --git a/docs/topics/searchdocs.rst → .../advanced-topics/search-in-django-cms.rst b/docs/topics/searchdocs.rst → .../advanced-topics/search-in-django-cms.rst
@@ -1,9 +1,13 @@
-#####################
-Search and django CMS
-#####################
+.. _advanced-topics-search-in-django-cms:
+
+####################
+Search In Django CMS
+####################
+
 
 For powerful full-text search within the django CMS, we suggest using
 `Haystack`_ together with `aldryn-search`_.
 
 .. _Haystack: http://haystacksearch.org/
 .. _aldryn-search: https://github.com/aldryn/aldryn-search
+
diff --git a/docs/topics/touch.rst → ...ced-topics/using-touch-screen-devices.rst b/docs/topics/touch.rst → ...ced-topics/using-touch-screen-devices.rst
@@ -1,8 +1,8 @@
-.. _touch:
+.. _advanced-topics-using-touch-screen-devices:
 
-##########################################
-Using touch-screen devices with django CMS
-##########################################
+##########################
+Using Touch Screen Devices
+##########################
 
 .. important::
 
@@ -117,3 +117,4 @@ Django Admin issues
 
 * In the page tree, the first touch on the page opens the keyboard which may be undesirable. This
   happens because Django automatically focuses the search form input.
+
diff --git a/docs/how_to/wizards.rst → ...to-implement-content-creation-wizards.rst b/docs/how_to/wizards.rst → ...to-implement-content-creation-wizards.rst
@@ -1,9 +1,9 @@
-.. versionadded:: 3.2
+.. _advanced-topics-wizard-how-to-implement-content-creation-wizards:
 
-.. _wizard_how_to:
+.. versionadded:: 3.2
 
 #########################################
-How to implement content creation wizards
+How To Implement Content Creation Wizards
 #########################################
 
 django CMS offers a framework for creating 'wizards' - helpers - for content editors.
@@ -130,3 +130,4 @@ each wizard's uniqueness is determined by its class and module name.
 
 See the :ref:`Reference section on wizards <wizard_reference>` for technical details of the wizards
 API.
+
diff --git a/docs/introduction/08-wizards.rst → docs/advanced-topics/wizard/index.rst b/docs/introduction/08-wizards.rst → docs/advanced-topics/wizard/index.rst
@@ -1,8 +1,15 @@
-:sequential_nav: both
+.. _advanced-topics-wizard:
 
-########################
-Content creation wizards
-########################
+######
+Wizard
+######
+
+
+.. _advanced-topics-wizard-introduction:
+
+************
+Introduction
+************
 
 Content creation wizards allow you to make use of the toolbar's **Create** button in your own
 applications. It opens up a simple dialog box with the basic fields required to create a new item.
@@ -52,3 +59,9 @@ offering you a new wizard for creating Polls.
 
     That would require a much more sophisticated form and processing than is possible within the
     scope of this tutorial.
+
+.. toctree::
+    :maxdepth: 1
+
+    how-to-implement-content-creation-wizards
+
diff --git a/docs/contributing/development-community.rst b/docs/contributing/development-community.rst