sphinx-markdown-builder

A Sphinx extension to add markdown generation support.

34 个版本 Python >=3.7
安装
pip install sphinx-markdown-builder
poetry add sphinx-markdown-builder
pipenv install sphinx-markdown-builder
conda install sphinx-markdown-builder
描述

sphinx-markdown-builder

Coverage Status

A Sphinx extension to add markdown generation support.

Install

pip3 install sphinx-markdown-builder==0.6.10

Usage

Add the extension to your conf.py file:

extensions = [
    ...,
    "sphinx_markdown_builder",
    ...,
]

Build markdown files with sphinx-build command

sphinx-build -M markdown ./docs ./build

Configurations

You can add the following configurations to your conf.py file:

  • markdown_anchor_sections/markdown_anchor_signatures: If set to True, then anchors will be added before each section/function/class signature. This allows references to a specific anchor in the document.
  • markdown_docinfo: Adds metadata to the top of each document containing author, copyright, and version.
  • markdown_http_base: If set, all references will link to this prefix address
  • markdown_uri_doc_suffix: If set, all references will link to documents with this suffix.
  • markdown_file_suffix: Sets the file extension for generated markdown files (default: .md).
  • markdown_bullet: Sets the bullet marker.
  • markdown_flavor: If set to github, output will suit GitHub's flavor of Markdown.

For example, if your conf.py file have the following configuration:

markdown_http_base = "https://your-domain.com/docs"
markdown_uri_doc_suffix = ".html"
markdown_bullet = "*"

Then a reference to your-doc-name#your-header will be substituted with https://your-domain.com/docs/your-doc-name.html#your-header.

Contributing

See the code contribution guidelines for more information.

Credits

This project forked from clayrisser/sphinx-markdown-builder, which was developed by Clay Risser under the MIT license.

The original implementation was based on doctree2md by Matthew Brett under the BSD-2 license.

License

MIT

版本列表
0.6.10 2026-03-11
0.6.9 2025-12-07
0.6.8 2025-01-19
0.6.7 2024-09-03
0.6.6 2024-01-16
0.6.5 2023-08-13
0.6.4 2023-07-22
0.6.3 2023-07-18
0.6.2 2023-07-03
0.6.1 2023-07-03
0.6.0 2023-06-25
0.5.5 2022-01-08
0.5.4 2019-12-23
0.5.3 2019-10-11
0.5.2 2019-09-10
0.5.1 2019-06-28
0.5.0 2019-06-27
0.4.1 2019-02-21
0.4.0 2019-02-05
0.3.0 2019-02-05
0.2.0 2019-01-25
0.1.7 2018-12-18
0.1.6 2018-12-04
0.1.5 2018-11-14
0.1.4 2018-11-14
0.1.3 2018-11-14
0.1.2 2018-11-14
0.1.1 2018-11-14
0.1.0 2018-11-14
0.0.5 2018-11-11
0.0.4 2018-11-11
0.0.3 2018-11-11
0.0.2 2018-11-11
0.0.1 2018-11-11