sphinx-markdown-builder
A Sphinx extension to add markdown generation support.
Install
pip3 install sphinx-markdown-builder==0.6.11
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_file_suffix: Sets the file extension for generated markdown files (default:.md).markdown_bullet: Sets the bullet marker.markdown_flavor: If set togithub, output will suit GitHub's flavor of Markdown.
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
2 maintainers
Release files for sphinx-markdown-builder 0.6.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_markdown_builder-0.6.11.tar.gz | 24.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_markdown_builder-0.6.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:42.1 kB
Release files / sphinx_markdown_builder-0.6.11.tar.gz
| Download URL | sphinx_markdown_builder-0.6.11.tar.gz |
|---|---|
| Size | 24.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ba3bf33e0e42ff30ae686ac73957a95e6d045790dcfbaca012dd8ae01794e577
|
|
BLAKE2b-256 checksum How to use checksums |
ad13102d7134743120db25e636ffb57a30818e95a416583dca83aadac9c5dd87
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / sphinx_markdown_builder-0.6.11-py3-none-any.whl
| Download URL | sphinx_markdown_builder-0.6.11-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
acfb94d6ee66c7a47da0ca0420578fa16f115812af25b8fd21755d5909aacf51
|
|
BLAKE2b-256 checksum How to use checksums |
c97106b415631c2e494c80546073b46013d1715dceb3abe30bd63b34b4e7d9ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
