Fixed some spelling and build issues (#6391)

django-cms · jrief · Feb 6, 2018 · Feb 6, 2018 · Feb 6, 2018 · Feb 6, 2018
commit 591efd6b120a4ace0bff70f4d57b17263ccad51a
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,7 +30,13 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 #extensions = ['sphinx.ext.autodoc']
 
-extensions = ['djangocms', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.autodoc']
+extensions = [
+    'djangocms',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.autodoc',
+    'sphinxcontrib.spelling'
+    ]
 intersphinx_mapping = {
     'python': ('http://docs.python.org/3/', None),
     'django': ('https://docs.djangoproject.com/en/1.11/', 'https://docs.djangoproject.com/en/1.11/_objects/'),

diff --git a/docs/how_to/toolbar.rst b/docs/how_to/toolbar.rst
@@ -4,8 +4,6 @@
 How to extend the Toolbar
 #########################
 
-.. versionadded:: 3.0
-
 You can add and remove toolbar items. This allows you to integrate django CMS's frontend editing
 mode into your application, and provide your users with a streamlined editing experience.
 
@@ -19,6 +17,7 @@ For the toolbar API reference, please refer to :ref:`toolbar-api-reference`.
 
     In other words, *sideframe* and the *overlay* refer to different versions of the same thing.
 
+
 ***********
 Registering
 ***********
@@ -106,7 +105,7 @@ When adding items, all arguments other than the name or identifier should be
 given as **keyword arguments**. This will help ensure that your custom toolbar
 items survive upgrades.
 
-Following our :doc:`/introduction/toolbar`, let's add the poll app
+Following our example in the :ref:`toolbar tutorial <toolbar_introduction>`, let's add the poll app
 to the toolbar::
 
     from django.core.urlresolvers import reverse

diff --git a/docs/reference/api_references.rst b/docs/reference/api_references.rst
@@ -66,52 +66,52 @@ Functions and constants
     creates a :class:`cms.models.Title` instance for the specified
     language.
 
-    :param string title: Title of the page
-    :param string template: Template to use for this page. Must be in :setting:`CMS_TEMPLATES`
-    :param string language: Language code for this page. Must be in :setting:`django:LANGUAGES`
-    :param string menu_title: Menu title for this page
-    :param string slug: Slug for the page, by default uses a slugified version of *title*
+    :param str title: Title of the page
+    :param str template: Template to use for this page. Must be in :setting:`CMS_TEMPLATES`
+    :param str language: Language code for this page. Must be in :setting:`django:LANGUAGES`
+    :param str menu_title: Menu title for this page
+    :param str slug: Slug for the page, by default uses a slugified version of *title*
     :param apphook: Application to hook on this page, must be a valid apphook
-    :type apphook: string or :class:`cms.app_base.CMSApp` sub-class
-    :param string apphook_namespace: Name of the apphook namespace
-    :param string redirect: URL redirect
-    :param string meta_description: Description of this page for SEO
+    :type apphook: str or :class:`cms.app_base.CMSApp` sub-class
+    :param str apphook_namespace: Name of the apphook namespace
+    :param str redirect: URL redirect
+    :param str meta_description: Description of this page for SEO
     :param created_by: User that is creating this page
-    :type created_by: string of :class:`django.contrib.auth.models.User` instance
+    :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 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 string reverse_id: Reverse ID of this page (for template tags)
-    :param string navigation_extenders: Menu to attach to this page. Must be a valid menu
+    :param str reverse_id: Reverse ID of this page (for template tags)
+    :param str navigation_extenders: Menu to attach to this page. Must be a valid menu
     :param bool published: Whether this page should be published or not
     :param site: Site to put this page on
     :type site: :class:`django.contrib.sites.models.Site` instance
     :param bool login_required: Whether users must be logged in or not to view this page
     :param limit_visibility_in_menu: Limits visibility of this page in the menu
     :type limit_visibility_in_menu: :data:`VISIBILITY_ALL` or :data:`VISIBILITY_USERS` or :data:`VISIBILITY_ANONYMOUS`
-    :param string position: Where to insert this node if *parent* is given, must be ``'first-child'`` or ``'last-child'``
-    :param string overwrite_url: Overwritten path for this page
+    :param str position: Where to insert this node if *parent* is given, must be ``'first-child'`` or ``'last-child'``
+    :param str   overwrite_url: Overwritten path for this page
     :param int xframe_options: X Frame Option value for Clickjacking protection
 
 
 .. function:: create_title(language, title, page, menu_title=None, slug=None, redirect=None, meta_description=None, parent=None, overwrite_url=None)
 
     Creates a :class:`cms.models.Title` instance and returns it.
 
-    :param string language: Language code for this page. Must be in :setting:`django:LANGUAGES`
-    :param string title: Title of the page
+    :param str language: Language code for this page. Must be in :setting:`django:LANGUAGES`
+    :param str title: Title of the page
     :param page: The page for which to create this title
     :type page: :class:`cms.models.Page` instance
-    :param string menu_title: Menu title for this page
-    :param string slug: Slug for the page, by default uses a slugified version of *title*
-    :param string redirect: URL redirect
-    :param string meta_description: Description of this page for SEO
+    :param str menu_title: Menu title for this page
+    :param str slug: Slug for the page, by default uses a slugified version of *title*
+    :param str redirect: URL redirect
+    :param str meta_description: Description of this page for SEO
     :param parent: Used for automated slug generation
     :type parent: :class:`cms.models.Page` instance
-    :param string overwrite_url: Overwritten path for this page
+    :param str overwrite_url: Overwritten path for this page
 
 
 .. function:: add_plugin(placeholder, plugin_type, language, position='last-child', target=None,  **data)
@@ -121,9 +121,9 @@ Functions and constants
     :param placeholder: Placeholder to add the plugin to
     :type placeholder: :class:`cms.models.placeholdermodel.Placeholder` instance
     :param plugin_type: What type of plugin to add
-    :type plugin_type: string or :class:`cms.plugin_base.CMSPluginBase` sub-class, must be a valid plugin
-    :param string language: Language code for this plugin, must be in :setting:`django:LANGUAGES`
-    :param string position: Position to add this plugin to the placeholder, must be a valid django-treebeard ``pos``
+    :type plugin_type: str or :class:`cms.plugin_base.CMSPluginBase` sub-class, must be a valid plugin
+    :param str language: Language code for this plugin, must be in :setting:`django:LANGUAGES`
+    :param str position: Position to add this plugin to the placeholder, must be a valid django-treebeard ``pos``
         value for :meth:`treebeard:treebeard.models.Node.add_sibling`
     :param target: Parent plugin. Must be plugin instance
     :param data: Data for the plugin type instance
@@ -165,14 +165,14 @@ Functions and constants
     :type page: :class:`cms.models.Page` instance
     :param user: The user that performs this action
     :type user: :class:`django.contrib.auth.models.User` instance
-    :param string language: The target language to publish to
+    :param str language: The target language to publish to
 
 .. function:: publish_pages(include_unpublished=False, language=None, site=None)
 
     Publishes multiple pages defined by parameters.
 
     :param bool include_unpublished: Set to ``True`` to publish all drafts, including unpublished ones; otherwise, only already published pages will be republished
-    :param string language: If given, only pages in this language will be published; otherwise, all languages will be published
+    :param str language: If given, only pages in this language will be published; otherwise, all languages will be published
     :param site: Specify a site to publish pages for specified site only; if not specified pages from all sites are published
     :type site: :class:`django.contrib.sites.models.Site` instance
 
@@ -196,8 +196,8 @@ Functions and constants
 
     :param page: the page to copy
     :type page: :class:`cms.models.Page` instance
-    :param string source_language: The source language code, must be in :setting:`django:LANGUAGES`
-    :param string target_language: The source language code, must be in :setting:`django:LANGUAGES`
+    :param str source_language: The source language code, must be in :setting:`django:LANGUAGES`
+    :param str target_language: The source language code, must be in :setting:`django:LANGUAGES`
     :param bool only_empty: if False, plugin are copied even if plugins exists in the
      target language (on a placeholder basis).
     :return int: number of copied plugins

diff --git a/docs/reference/configuration.rst b/docs/reference/configuration.rst
@@ -437,7 +437,7 @@ Example::
 .. _i18n_l10n_reference:
 
 *****************************************************
-Internationalisation and localisation (I18N and L10N) 
+Internationalisation and localisation (I18N and L10N)
 *****************************************************
 
 CMS_LANGUAGES
@@ -573,7 +573,7 @@ default
 hide_untranslated
 -----------------
 
-Hides untranslated pages in menus. 
+Hides untranslated pages in menus.
 
 When applied to the ``default`` directive, if ``False``, all pages in menus will be listed in all languages, including those
 that don't yet have content in a particular language. If ``True``, untranslated pages will be hidden.
@@ -612,7 +612,7 @@ Unicode support for automated slugs
 If your site has languages which use non-ASCII character sets, :setting:`CMS_UNIHANDECODE_HOST` and
 :setting:`CMS_UNIHANDECODE_VERSION` will allow it to automate slug generation for those languages too.
 
-Support for this is provided by the unihandecode.js project. 
+Support for this is provided by the unihandecode.js project.
 
 
 ..  setting:: CMS_UNIHANDECODE_HOST
@@ -786,7 +786,7 @@ CMS_REQUEST_IP_RESOLVER
 =======================
 
 default
-    'cms.utils.request_ip_resolvers.default_request_ip_resolver'
+    '`cms.utils.request_ip_resolvers.default_request_ip_resolver`'
 
 This setting is used system-wide to provide a consistent and plug-able means
 of extracting a client IP address from the HTTP request. The default

diff --git a/docs/reference/navigation.rst b/docs/reference/navigation.rst
@@ -314,8 +314,8 @@ Menu system classes and function
 
     Each node in a menu tree is represented by a ``NavigationNode`` instance.
 
-    :param string title: The title to display this menu item with.
-    :param string url: The URL associated with this menu item.
+    :param str title: The title to display this menu item with.
+    :param str url: The URL associated with this menu item.
     :param id: Unique (for the current tree) ID of this item.
     :param parent_id: Optional, ID of the parent item.
     :param parent_namespace: Optional, namespace of the parent.

diff --git a/docs/reference/templatetags.rst b/docs/reference/templatetags.rst
@@ -516,7 +516,7 @@ This will render to:
     model attribute. This helps prevent a range of security vulnerabilities
     stemming from HTML, JavaScript, and CSS Code Injection.
 
-    To change this behavior, the project administrator should carefully review
+    To change this behaviour, the project administrator should carefully review
     each use of this template tag and ensure that all content which is rendered
     to a page using this template tag is cleansed of any potentially harmful
     HTML markup, CSS styles or JavaScript.
@@ -598,7 +598,7 @@ method is available; also template tags and filters are available in the block.
     model attribute. This helps prevent a range of security vulnerabilities
     stemming from HTML, JavaScript, and CSS Code Injection.
 
-    To change this behavior, the project administrator should carefully review
+    To change this behaviour, the project administrator should carefully review
     each use of this template tag and ensure that all content which is rendered
     to a page using this template tag is cleansed of any potentially harmful
     HTML markup, CSS styles or JavaScript.
@@ -665,7 +665,7 @@ It will render to something like:
     model attribute. This helps prevent a range of security vulnerabilities
     stemming from HTML, JavaScript, and CSS Code Injection.
 
-    To change this behavior, the project administrator should carefully review
+    To change this behaviour, the project administrator should carefully review
     each use of this template tag and ensure that all content which is rendered
     to a page using this template tag is cleansed of any potentially harmful
     HTML markup, CSS styles or JavaScript.
@@ -728,7 +728,7 @@ It will render to something like:
     model attribute. This helps prevent a range of security vulnerabilities
     stemming from HTML, JavaScript, and CSS Code Injection.
 
-    To change this behavior, the project administrator should carefully review
+    To change this behaviour, the project administrator should carefully review
     each use of this template tag and ensure that all content which is rendered
     to a page using this template tag is cleansed of any potentially harmful
     HTML markup, CSS styles or JavaScript.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,7 +3,8 @@ MarkupSafe==0.23
 Pygments==2.0.2
 sphinx
 # temporarily disabled because of an issue on RTD. see also conf.py
-#sphinxcontrib-spelling
+sphinxcontrib-spelling
 pyenchant
 sphinx-autobuild
 divio-docs-theme
+datetime