Skip to content

Commit e73e21b

Browse files
committed
chore: Update headings as per edX guidelines
1 parent 5bdafb0 commit e73e21b

File tree

2 files changed

+6
-15
lines changed

2 files changed

+6
-15
lines changed

Diff for: docs/xblock-utils/index.rst

+6-10
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
11
.. _XBlock Utils:
22

33

4-
############
54
Xblock.utils
65
############
76

8-
********************************************
97
Package having various utilities for XBlocks
108
********************************************
119

1210

13-
=======
1411
Purpose
1512
=======
1613

1714
``xblock/utils`` package contains a collection of utility functions and base test classes that are useful for any XBlock.
1815

1916

20-
==============
2117
Documentation
22-
==============
18+
=============
2319

2420

2521
StudioEditableXBlockMixin
26-
*************************
22+
-------------------------
2723

2824
.. code:: python
2925
@@ -119,7 +115,7 @@ Supported field options (all field types):
119115
Basic screenshot: |Screenshot 1|
120116

121117
StudioContainerXBlockMixin
122-
**************************
118+
-------------------------
123119

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

139135

140136
child\_isinstance
141-
*****************
137+
-------------------------
142138

143139
.. code:: python
144140
@@ -164,13 +160,13 @@ orders of magnitude faster.
164160
.. |Screenshot 2| image:: Images/Screenshot_2.png
165161

166162
XBlockWithSettingsMixin
167-
***********************
163+
-------------------------
168164

169165
This mixin provides access to instance-wide XBlock-specific configuration settings.
170166
See :ref:`accessing-xblock-specific-settings` for details.
171167

172168
ThemableXBlockMixin
173-
*******************
169+
-------------------------
174170

175171
This mixin provides XBlock theming capabilities built on top of XBlock-specific settings.
176172
See :ref:`theming-support` for details.

Diff for: docs/xblock-utils/settings-and-theme-support.rst

-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
.. _settings-and-theme-support:
22

33

4-
##########################
54
Settings and theme support
65
##########################
76

87
.. _accessing-xblock-specific-settings:
98

10-
**********************************
119
Accessing XBlock specific settings
1210
**********************************
1311

@@ -36,7 +34,6 @@ mutable settings. Both ``SettingsService`` and
3634
bucket and return them as is. Refer to the ``SettingsService`` docstring
3735
and implementation for more details.
3836

39-
=============================
4037
Using XBlockWithSettingsMixin
4138
=============================
4239

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

6158
.. _theming-support:
6259

63-
***************
6460
Theming support
6561
***************
6662

@@ -117,7 +113,6 @@ belonging to a theme with a global CSS selector
117113
not automatically added by ``ThemableXBlockMixin``, so one needs to add
118114
it manually.
119115

120-
=========================
121116
Using ThemableXBlockMixin
122117
=========================
123118

0 commit comments

Comments
 (0)