A Sphinx extension to add markdown generation support.
Project Links
Meta
Author: Liran Funaro
Requires Python: >=3.7
Classifiers
Framework
- Sphinx :: Extension
Programming Language
- Python
- Python :: 3
License
- OSI Approved :: MIT License
Operating System
- OS Independent
Topic
- Software Development :: Libraries :: Python Modules
sphinx-markdown-builder
A Sphinx extension to add markdown generation support.
Install
pip3 install sphinx-markdown-builder==0.6.8
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 toTrue, 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 addressmarkdown_uri_doc_suffix: If set, all references will link to documents with this suffix.markdown_bullet: Sets the bullet marker.
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
0.6.8
Jan 19, 2025
0.6.7
Sep 03, 2024
0.6.6
Jan 16, 2024
0.6.5
Aug 13, 2023
0.6.4
Jul 22, 2023
0.6.3
Jul 18, 2023
0.6.2
Jul 03, 2023
0.6.1
Jul 03, 2023
0.6.0
Jun 25, 2023
0.5.5
Jan 08, 2022
0.5.4
Dec 23, 2019
0.5.3
Oct 11, 2019
0.5.2
Sep 10, 2019
0.5.1
Jun 28, 2019
0.5.0
Jun 27, 2019
0.4.1
Feb 21, 2019
0.4.0
Feb 05, 2019
0.3.0
Feb 05, 2019
0.2.0
Jan 25, 2019
0.1.7
Dec 18, 2018
0.1.6
Dec 04, 2018
0.1.5
Nov 14, 2018
0.1.4
Nov 14, 2018
0.1.3
Nov 14, 2018
0.1.2
Nov 14, 2018
0.1.1
Nov 14, 2018
0.1.0
Nov 14, 2018
0.0.5
Nov 11, 2018
0.0.4
Nov 11, 2018
0.0.3
Nov 11, 2018
0.0.2
Nov 11, 2018
0.0.1
Nov 11, 2018
