A Sphinx extension to add markdown generation support.
Project description
sphinx-markdown-builder
A Sphinx extension to add markdown generation support.
Install
pip3 install sphinx-markdown-builder==0.6.1
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.
For example, if your conf.py
file have the following configuration:
markdown_http_base = "https://your-domain.com/docs"
markdown_uri_doc_suffix = ".html"
Then a reference to your-doc-name#your-header
will be substituted with https://your-domain.com/docs/your-doc-name.html#your-header
.
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-markdown-builder-0.6.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11ca5b8f91db4908f556f2ddeccf9f0b0046a2c92a2c71bbec0acd0659887bfd |
|
MD5 | 78e1bc2db0acc7bed018d672ceeb9f9f |
|
BLAKE2b-256 | 4b207e1a07ce0714ced56cf2470877a7ffbeb631c5001a1c64f9dc861b2db73d |
Hashes for sphinx_markdown_builder-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8a413dcf33f44fa903e339a8938ccf7f6aed10d1e92478fa85688d007c6131af |
|
MD5 | a36d916cf3deebd252c0348332d1b415 |
|
BLAKE2b-256 | dc615c48646542d106785472cbd56ef51aa93c955f58091f348353323e871d38 |