{"library":"recommonmark","title":"recommonmark","description":"recommonmark provides a compatibility bridge to CommonMark, allowing users to write Markdown files within Docutils and Sphinx projects. It parses CommonMark-compliant Markdown into a Docutils abstract syntax tree, integrating it into the Sphinx build process. The library's last release was in December 2020, and it is officially deprecated in favor of MyST-Parser.","language":"python","status":"deprecated","last_verified":"Fri May 15","install":{"commands":["pip install recommonmark"],"cli":null},"imports":["extensions = ['recommonmark']","from recommonmark.transform import AutoStructify"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"# conf.py\n\nimport os\nimport sys\nsys.path.insert(0, os.path.abspath('.'))\n\n# -- Project information -----------------------------------------------------\nproject = 'My Project'\ncopyright = '2026, Your Name'\nauthor = 'Your Name'\n\n# The full version, including alpha/beta/rc tags\nrelease = '0.1.0'\n\n# -- General configuration ---------------------------------------------------\n\n# Add any Sphinx extension module names here, as strings. They can be\n# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\n# ones.\nextensions = [\n    'sphinx.ext.autodoc',\n    'sphinx.ext.napoleon',\n    'sphinx.ext.autosectionlabel',\n    'recommonmark',\n]\n\n# Add any paths that contain templates here, relative to this directory.\ntemplates_path = ['_templates']\n\n# The suffix(es) of source filenames. You can specify multiple suffix as a list of string:\nsource_suffix = ['.rst', '.md']\n\n# The master toctree document.\nmaster_doc = 'index'\n\n# -- Options for AutoStructify (recommonmark's advanced features) -----------\nfrom recommonmark.transform import AutoStructify\n\ndef setup(app):\n    app.add_config_value(\n        'recommonmark_config',\n        {\n            'enable_auto_toc_tree': True,\n            'enable_math': True,\n            'enable_inline_math': True,\n            'enable_eval_rst': True,\n            'enable_auto_doc_ref': True,\n        },\n        True,\n    )\n    app.add_transform(AutoStructify)\n\n# Ensure that autosectionlabel prefixes document path to avoid conflicts\nautosectionlabel_prefix_document = True\n\n# -- Options for HTML output -------------------------------------------------\nhtml_theme = 'alabaster'\n\n# -- Generate a dummy index.md for demonstration --\n# This would typically be an actual .md file in your source directory\nwith open('index.md', 'w') as f:\n    f.write('# Welcome to My Project\\n\\nThis is a Markdown file processed by recommonmark.\\n\\n## Features\\n\\n*   Easy integration\\n*   Supports basic CommonMark\\n*   Advanced features via AutoStructify\\n')\n\n# To build the docs, run `sphinx-build -b html . _build` in a terminal where this conf.py exists.\n","lang":"python","description":"To integrate recommonmark with Sphinx, you primarily add it to your `extensions` list in `conf.py`. For advanced features like automatic table of contents generation or embedding reStructuredText within Markdown, you must also import and register `AutoStructify` with specific configurations. This example also demonstrates how to enable `autosectionlabel` and prevent common conflicts.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-15","installed_version":"0.7.1","pypi_latest":"0.7.1","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":5.3,"avg_import_s":0,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.7M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.1,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"101.9M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5.2,"import_time_s":0,"mem_mb":0,"disk_size":"102M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.9M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":5,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.8M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":4.9,"import_time_s":0,"mem_mb":0,"disk_size":"93M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0,"mem_mb":0,"disk_size":"92.0M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"recommonmark","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"clean","install_time_s":6.1,"import_time_s":0,"mem_mb":0,"disk_size":"92M"}]}}