Small docs update

django-cms · vinitkumar · Mar 3, 2025 · Mar 1, 2025 · Mar 1, 2025 · Mar 1, 2025
commit d82a92823bb0560623678a9a0031b0331c9f5a9c
diff --git a/cms/toolbar/items.py b/cms/toolbar/items.py
@@ -417,7 +417,7 @@ def __repr__(self):
 class ModalItem(FrameItem):
     """
     Sends a GET request; loads response in a modal window. Use an
-    :class:`~ToolbarAPIMixin.add_modal_item` method to create a ``ModalItem`` instance. Can be
+    :class:`~cms.toolbar.items.ToolbarAPIMixin.add_modal_item` method to create a ``ModalItem`` instance. Can be
     added to :class:`~cms.toolbar.toolbar.CMSToolbar`, :class:`~cms.toolbar.items.Menu`,
     :class:`~cms.toolbar.items.SubMenu`.
     """
@@ -429,7 +429,7 @@ def __repr__(self):
 
 class AjaxItem(BaseItem):
     """
-    Sends a POST request. Use an :class:`~ToolbarAPIMixin.add_ajax_item` method to create a
+    Sends a POST request. Use an :class:`~cms.toolbar.items.ToolbarAPIMixin.add_ajax_item` method to create a
     ``AjaxItem`` instance. Can be added to :class:`~cms.toolbar.toolbar.CMSToolbar`,
     :class:`~cms.toolbar.items.Menu`, :class:`~cms.toolbar.items.SubMenu`.
 

diff --git a/cms/toolbar/toolbar.py b/cms/toolbar/toolbar.py
@@ -565,7 +565,7 @@ def render_with_structure(self, context, nodelist):
         return f'{toolbar}\n{rendered_contents}'
 
 
-# Add toolbar mixins from extensions to toolbar
+#: :class:`CMSToolbarBase` including toolbar mixins from extensions to toolbar
 CMSToolbar = type("CMSToolbar", tuple(cms_toolbar_extensions + [CMSToolbarBase]), dict())
 
 

diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst
@@ -15,6 +15,7 @@ with explaining *how to do things* than with helping you understand *how it work
     multiple_languages
     i18n
     permissions
+    searchdocs
     touch
     colorscheme
     menu_system

diff --git a/docs/requirements.in b/docs/requirements.in
@@ -10,8 +10,8 @@ sphinx-autobuild
 datetime
 coverage
 django~=4.2
-git+https://github.com/django-cms/django-cms@release/4.1.x
+-e ..
 codespell
 pip-tools
 docstrfmt
-git+https://github.com/django-cms/djangocms-ecosystem
+git+https://github.com/django-cms/djangocms-ecosystem  # important to install directly from github
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,6 +6,8 @@
 #
 --extra-index-url https://www.piwheels.org/simple
 
+-e ..
+    # via -r requirements.in
 alabaster==1.0.0
     # via sphinx
 anyio==4.6.0
@@ -53,8 +55,6 @@ django-classy-tags==4.1.0
     # via
     #   django-cms
     #   django-sekizai
-django-cms @ git+https://github.com/django-cms/django-cms@release/4.1.x
-    # via -r requirements.in
 django-formtools==2.5.1
     # via django-cms
 django-sekizai==4.1.0

diff --git a/docs/upgrade/3.0.6.rst b/docs/upgrade/3.0.6.rst
@@ -48,7 +48,7 @@ filters in ``PageUserAdmin`` as in the custom user model admin.
 
 A new method on plugins, that returns the template during the render phase,
 allowing you to change the template based on any plugin attribute or context
-status. See :doc:`/how_to/custom_plugins` for more.
+status. See :doc:`/how_to/09-custom_plugins` for more.
 
 Simplified toolbar API for page extensions
 ==========================================

diff --git a/docs/upgrade/3.0.rst b/docs/upgrade/3.0.rst
@@ -38,7 +38,7 @@ New Toolbar
 
 The toolbar's code has been simplified and its appearance refreshed. The
 toolbar is now a more consistent management tool for adding and changing
-objects. See :doc:`/how_to/toolbar`.
+objects. See :doc:`/how_to/13-toolbar`.
 
 .. warning:: Upgrading from previous versions
 

diff --git a/docs/upgrade/3.1.rst b/docs/upgrade/3.1.rst
@@ -61,7 +61,7 @@ Other than this, end users should not notice any changes.
 Action required
 ---------------
 
-Run :ref:`manage.py cms fix-mptt <fix-mptt>` before you upgrade.
+Run ``manage.py cms fix-mptt`` before you upgrade.
 
 Developers who use django CMS will need to run the schema and data migrations that are part of this
 release. Developers of third-party applications that relied on the Django MPTT that shipped with
@@ -198,7 +198,7 @@ Check the readme file of each plugin when upgrading to know the actions required
 Structure mode permission
 =========================
 
-A new :doc:`Can use Structure mode* permission </topics/permissions>` has been added.
+A new :doc:`Can use Structure mode* permission </explanation/permissions>` has been added.
 
 Without this permission, a non-superuser will no longer have access to structure mode. This makes
 possible a more strict workflow, in which certain users are able to edit content but not structure.
@@ -236,7 +236,7 @@ including the use of "clipboard-like" items.
 Per-namespace apphook configuration
 ===================================
 
-django CMS provides a new API to define namespaced :doc:`Apphook </how_to/apphooks>` configurations.
+django CMS provides a new API to define namespaced :doc:`Apphook </how_to/11-apphooks>` configurations.
 
 `Aldryn Apphooks Config <https://github.com/aldryn/aldryn-apphooks-config>`_ has
 been created and released as a standard implementation to take advantage