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.
pip install sphinx-markdown-builderNo compatibility data collected yet for this library.
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.
Upgrade `sphinx-markdown-builder` to a version that explicitly supports your Sphinx version. Check the package's release notes or GitHub page for detailed compatibility information.
Ensure your Python environment is 3.7 or newer. Upgrade your Python version if using an older version.
To ensure `.md` extensions, configure `markdown_builder_uri = "{path}.md"` in your `conf.py` file.Install the package using pip: `pip install sphinx-markdown-builder`
Add `'sphinx_markdown_builder'` to the `extensions` list in your `conf.py`:
```python
# conf.py
extensions = [
'sphinx_markdown_builder',
# ... other extensions
]
```Correct the spelling of the configuration variable in `conf.py` (e.g., `markdown_builder_output_dir` instead of `markdown_builder_outputdir`). Refer to the official documentation for the exact variable names.