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.7
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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9623c8d5963e18b3733ec8335a48b58c3e556a96529b73e4c65113cabd8e8591 |
|
MD5 | 29e301556c36b2bed22b14f6b47ea878 |
|
BLAKE2b-256 | 4bd5abe8eba9564b9f15d72a9fc658f644116e116ea382b09aea05dff8b7a8c2 |
Hashes for sphinx_markdown_builder-0.6.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d52b63d2b7b3504ca664773e805b0ee8957239f2ca86103e793d96103970839 |
|
MD5 | 3402b9806330c7d7f4b3bdf60fae782d |
|
BLAKE2b-256 | d9c449acc41fd145bf1b447da3d0b146dac5533e8f00b0035ea7822bb7c9a2fe |