{"library":"sphinx-markdown-builder","title":"Sphinx Markdown Builder","type":"library","description":"sphinx-markdown-builder is a Sphinx extension that enables the generation of documentation in Markdown format. It extends Sphinx's build capabilities, allowing users to build their existing reStructuredText or MyST Markdown projects into standard Markdown files. The current version is 0.6.10, and it generally follows a release cadence tied to major Sphinx versions and critical bug fixes.","language":"python","status":"active","last_verified":"Tue Apr 14","install":{"commands":["pip install sphinx-markdown-builder"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/liran-funaro/sphinx-markdown-builder","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinx-markdown-builder/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# Save this as docs/conf.py (after running sphinx-quickstart)\nimport os\nimport sys\n# Assuming your Sphinx project root is 'docs'\nsys.path.insert(0, os.path.abspath('.'))\n\nproject = 'My Markdown Docs'\ncopyright = '2024, AI Assistant'\nextensions = [\n    'sphinx_markdown_builder',\n    # Other Sphinx extensions can go here, e.g., 'sphinx.ext.autodoc'\n]\n\n# Configure output Markdown file extension\nmarkdown_builder_uri = '{path}.md'\n\n# Minimal settings for Markdown output\n# Add other Sphinx standard configurations as needed\nhtml_theme = 'alabaster' # A theme is typically required by Sphinx init\n\n# Example index.rst content (save as docs/index.rst):\n# ===================\n# My Markdown Docs\n# ===================\n#\n# Hello World!\n","lang":"python","description":"To quickly generate Markdown from your Sphinx project, first create a basic Sphinx project (e.g., `sphinx-quickstart docs`). Then, modify `docs/conf.py` to include `sphinx_markdown_builder` in your `extensions` list and set `markdown_builder_uri = '{path}.md'` for correct file extensions. Finally, run `sphinx-build -b markdown docs _build/markdown` from your project's root directory to generate Markdown output.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}