Skip to content

Commit

Permalink
chore: Update headings as per edX guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
farhan committed Sep 22, 2023
1 parent 5bdafb0 commit e73e21b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
16 changes: 6 additions & 10 deletions docs/xblock-utils/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -119,7 +115,7 @@ Supported field options (all field types):
Basic screenshot: |Screenshot 1|

StudioContainerXBlockMixin
**************************
-------------------------

.. code:: python
Expand All @@ -138,7 +134,7 @@ An example is the mentoring XBlock: |Screenshot 2|


child\_isinstance
*****************
-------------------------

.. code:: python
Expand All @@ -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.
Expand Down
5 changes: 0 additions & 5 deletions docs/xblock-utils/settings-and-theme-support.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
.. _settings-and-theme-support:


##########################
Settings and theme support
##########################

.. _accessing-xblock-specific-settings:

**********************************
Accessing XBlock specific settings
**********************************

Expand Down Expand Up @@ -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
=============================

Expand All @@ -60,7 +57,6 @@ settings key is not found) ``default`` value is used.

.. _theming-support:

***************
Theming support
***************

Expand Down Expand Up @@ -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
=========================

Expand Down

0 comments on commit e73e21b

Please sign in to comment.