Skip to content

Commit 76dec68

Browse files
committed
Add documentation for renderer heading when TOC enabled
ref: #251
1 parent 799cd11 commit 76dec68

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/advanced.rst

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Here is a a list of available renderer functions::
3737
# block level
3838
paragraph(self, text)
3939
heading(self, text, level)
40+
heading(self, text, level, tid) # when TOC directive is enabled
4041
thematic_break(self)
4142
block_text(self, text)
4243
block_code(self, code, info=None)

docs/directives.rst

+11
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,17 @@ TOC plugin::
7575
plugins=[DirectiveToc()]
7676
)
7777

78+
If **TOC** directive is enabled, the ``heading`` method of renderer will accept
79+
one more paramter::
80+
81+
def heading(self, text, level):
82+
# without TOC directive
83+
return ''
84+
85+
def heading(self, text, level, tid):
86+
# with TOC directive
87+
return ''
88+
7889
Include
7990
-------
8091

0 commit comments

Comments
 (0)