Sphinx builder that generates markdown files from reStructuredText.
Project description
sphinx-markdown-builder
Sphinx builder that generates markdown files from reStructuredText.
Install
pip3 install sphinx-markdown-builder==0.6.0
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_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_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.
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 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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac4bcdc70f4e60cda7b39f100076d1ae7060b21925f404a3cae9638e802f9776 |
|
MD5 | ddf1ab378b61a546b78383a7259d8c9d |
|
BLAKE2b-256 | 3602e932b308f6a0b018501ba3396d3dde03e32a428c398784f7ecc2bb17eefc |
Hashes for sphinx_markdown_builder-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34bb3d86e1e0e8a2c03e10928b6d2d3e9819fe49e94cf41fd5bda4bb2cfa9f7d |
|
MD5 | a5e5d501c042af0d8e064ebec866b3bd |
|
BLAKE2b-256 | b23e3ed7174c4d078cc9f02ad8c3077e73727094fd6a58bf78cae6a9744eb3c3 |