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.6
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
.
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
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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | febd8e03e20e357e624c52efdc7ef9d5ab70d58549784158033c9657d040f44e |
|
MD5 | 7f1968d4277611ded74e12df827f8b5a |
|
BLAKE2b-256 | fdc5dc3ca615b0a5a687a7db9d35e3bcfb764169c8dbedaade221bf7b29f5ce9 |
Hashes for sphinx_markdown_builder-0.6.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6fd4626c6daf1c25a464fd7d6d64e4a97e69abca1684fb2a12fba44cb6db363 |
|
MD5 | 7bd961418057c1ddb4fcc0d5d0ba5075 |
|
BLAKE2b-256 | d77ff41994556acf1ad279de9c15431f3b8f14e4a0de20d8389fdccd59954e8d |