hiro/recommonmark
1
0
Fork 0
mirror of https://github.com/vale981/recommonmark synced 2025-03-05 10:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Allow the Auto TOC maxdepth to be configurable.

Browse source 
This adds the 'auto_toc_maxdepth' config option (defaults to 1) that
will set the max depth for the auto-generated table of contents.
This commit is contained in:
Tommy Beadle 2019-06-21 15:12:08 -04:00
parent 98200fc475
commit 4bd0eab865
2 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -105,6 +105,7 @@ See https://github.com/rtfd/recommonmark/blob/master/docs/conf.py for a full exa
AutoStructify comes with the following options. See [http://recommonmark.readthedocs.org/en/latest/auto_structify.html](http://recommonmark.readthedocs.org/en/latest/auto_structify.html) for more information about the specific features. AutoStructify comes with the following options. See [http://recommonmark.readthedocs.org/en/latest/auto_structify.html](http://recommonmark.readthedocs.org/en/latest/auto_structify.html) for more information about the specific features.
* __enable_auto_toc_tree__: enable the Auto Toc Tree feature. * __enable_auto_toc_tree__: enable the Auto Toc Tree feature.
* __auto_toc_maxdepth__: The max depth of the Auto Toc. Defaults to 1.
* __auto_toc_tree_section__: when True, Auto Toc Tree will only be enabled on section that matches the title. * __auto_toc_tree_section__: when True, Auto Toc Tree will only be enabled on section that matches the title.
* __enable_auto_doc_ref__: enable the Auto Doc Ref feature. **Deprecated** * __enable_auto_doc_ref__: enable the Auto Doc Ref feature. **Deprecated**
* __enable_math__: enable the Math Formula feature. * __enable_math__: enable the Math Formula feature.

6
recommonmark/transform.py
View file

@ -41,6 +41,7 @@ class AutoStructify(transforms.Transform):
default_config = { default_config = {
'enable_auto_doc_ref': False, 'enable_auto_doc_ref': False,
'auto_toc_maxdepth': 1,
'auto_toc_tree_section': None, 'auto_toc_tree_section': None,
'enable_auto_toc_tree': True, 'enable_auto_toc_tree': True,
'enable_eval_rst': True, 'enable_eval_rst': True,
@ -179,7 +180,10 @@ class AutoStructify(transforms.Transform):
self.current_level) self.current_level)
return self.state_machine.run_directive( return self.state_machine.run_directive(
'toctree', 'toctree',
options={'maxdepth': 1, 'numbered': numbered}, options={
'maxdepth': self.config['auto_toc_maxdepth'],
'numbered': numbered,
},
content=['%s <%s>' % (k, v) for k, v in refs]) content=['%s <%s>' % (k, v) for k, v in refs])
def auto_inline_code(self, node): def auto_inline_code(self, node):