Skip to content

Commit

Permalink
Fixed broken documentation references
Browse files Browse the repository at this point in the history
  • Loading branch information
evildmp committed Dec 13, 2018
1 parent 68988ac commit 6be77fd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 15 deletions.
18 changes: 6 additions & 12 deletions docs/how_to/extending_page_title.rst
Expand Up @@ -401,15 +401,9 @@ Simplified Toolbar API
The simplified Toolbar API works by deriving your toolbar class from ``ExtensionToolbar``
which provides the following API:


* :meth:`cms.extensions.toolbar.ExtensionToolbar._setup_extension_toolbar`: this must be called first to setup
the environment and do the permission checking;
* :py:meth:`~cms.extensions.toolbar.ExtensionToolbar.get_page_extension_admin()`: for page extensions, retrieves the
correct admin URL for the related toolbar item; returns the extension instance (or `None` if not exists)
and the admin URL for the toolbar item;
* :py:meth:`~cms.extensions.toolbar.ExtensionToolbar.get_title_extension_admin()`: for title extensions, retrieves the
correct admin URL for the related toolbar item; returns a list of the extension instances
(or `None` if not exists) and the admin urls for each title of the current page;

* :meth:`cms.toolbar.toolbar.CMSToolbar.get_or_create_menu`
* :meth:`cms.extensions.toolbar.ExtensionToolbar._setup_extension_toolbar`
* ``ExtensionToolbar.get_page_extension_admin()``: for page extensions, retrieves the correct admin
URL for the related toolbar item; returns the extension instance (or ``None`` if none exists) and
the admin URL for the toolbar item
* ``ExtensionToolbar.get_title_extension_admin()``: for title extensions, retrieves the correct
admin URL for the related toolbar item; returns a list of the extension instances (or ``None`` if
none exists) and the admin URLs for each title of the current page
2 changes: 1 addition & 1 deletion docs/how_to/toolbar.rst
Expand Up @@ -414,7 +414,7 @@ you can do this by creating a sub-class of it that implements the required chang
that instead of the original.

The original can be unregistered using ``toolbar_pool.unregister()``, as in the example below.
Alternatively if you orginally invoked the toolbar class using :setting:`CMS_TOOLBARS`, you will
Alternatively if you originally invoked the toolbar class using :setting:`CMS_TOOLBARS`, you will
need to modify that to refer to the new one instead.

An example, in which we unregister the original and register our own::
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api_references.rst
Expand Up @@ -80,8 +80,8 @@ Functions and constants
:type created_by: str of :class:`django.contrib.auth.models.User` instance
:param parent: Parent page of this page
:type parent: :class:`cms.models.Page` instance
:param datetime publication_date: Date to publish this page
:param datetime publication_end_date: Date to unpublish this page
:param datetime.datetime publication_date: Date to publish this page
:param datetime.datetime publication_end_date: Date to unpublish this page
:param bool in_navigation: Whether this page should be in the navigation or not
:param bool soft_root: Whether this page is a soft root or not
:param str reverse_id: Reverse ID of this page (for template tags)
Expand Down

0 comments on commit 6be77fd

Please sign in to comment.