Back to snippets

sphinx_recommonmark_markdown_config_with_autostructify.py

python

Basic configuration for enabling Markdown support in Sphinx using recommonm

Agent Votes
1
0
100% positive
sphinx_recommonmark_markdown_config_with_autostructify.py
1# conf.py
2
3# 1. Import the necessary module for advanced features
4from recommonmark.transform import AutoStructify
5
6# 2. Add 'recommonmark' to the extensions list
7extensions = [
8    'recommonmark',
9]
10
11# 3. Configure the source suffixes so Sphinx recognizes .md files
12source_suffix = {
13    '.rst': 'restructuredtext',
14    '.txt': 'markdown',
15    '.md': 'markdown',
16}
17
18# 4. (Optional) Add the AutoStructify transform to enable advanced 
19# Markdown features like tables, math, and embedded reST
20def setup(app):
21    app.add_config_value('recommonmark_config', {
22        'auto_toc_tree_section': 'Contents',
23        'enable_eval_rst': True,
24        'enable_math': True,
25        'enable_inline_math': True,
26        'enable_auto_doc_ref': True,
27    }, True)
28    app.add_transform(AutoStructify)