diff --git a/docs/xblock-utils/index.rst b/docs/xblock-utils/index.rst index 81c8f5d13..c5dd6dae9 100644 --- a/docs/xblock-utils/index.rst +++ b/docs/xblock-utils/index.rst @@ -1,29 +1,25 @@ .. _XBlock Utils: -############ Xblock.utils ############ -******************************************** Package having various utilities for XBlocks ******************************************** -======= Purpose ======= ``xblock/utils`` package contains a collection of utility functions and base test classes that are useful for any XBlock. -============== Documentation -============== +============= StudioEditableXBlockMixin -************************* +------------------------- .. code:: python @@ -119,7 +115,7 @@ Supported field options (all field types): Basic screenshot: |Screenshot 1| StudioContainerXBlockMixin -************************** +------------------------- .. code:: python @@ -138,7 +134,7 @@ An example is the mentoring XBlock: |Screenshot 2| child\_isinstance -***************** +------------------------- .. code:: python @@ -164,13 +160,13 @@ orders of magnitude faster. .. |Screenshot 2| image:: Images/Screenshot_2.png XBlockWithSettingsMixin -*********************** +------------------------- This mixin provides access to instance-wide XBlock-specific configuration settings. See :ref:`accessing-xblock-specific-settings` for details. ThemableXBlockMixin -******************* +------------------------- This mixin provides XBlock theming capabilities built on top of XBlock-specific settings. See :ref:`theming-support` for details. diff --git a/docs/xblock-utils/settings-and-theme-support.rst b/docs/xblock-utils/settings-and-theme-support.rst index e892f50a1..1b4b9fa83 100644 --- a/docs/xblock-utils/settings-and-theme-support.rst +++ b/docs/xblock-utils/settings-and-theme-support.rst @@ -1,13 +1,11 @@ .. _settings-and-theme-support: -########################## Settings and theme support ########################## .. _accessing-xblock-specific-settings: -********************************** Accessing XBlock specific settings ********************************** @@ -36,7 +34,6 @@ mutable settings. Both ``SettingsService`` and bucket and return them as is. Refer to the ``SettingsService`` docstring and implementation for more details. -============================= Using XBlockWithSettingsMixin ============================= @@ -60,7 +57,6 @@ settings key is not found) ``default`` value is used. .. _theming-support: -*************** Theming support *************** @@ -117,7 +113,6 @@ belonging to a theme with a global CSS selector not automatically added by ``ThemableXBlockMixin``, so one needs to add it manually. -========================= Using ThemableXBlockMixin =========================