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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_markdown_builder-0.6.11.tar.gz.
File metadata
- Download URL: sphinx_markdown_builder-0.6.11.tar.gz
- Upload date:
- Size: 24.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ba3bf33e0e42ff30ae686ac73957a95e6d045790dcfbaca012dd8ae01794e577
|
|
| MD5 |
c5d37225d9f6cbefd153a6ee5bb0ef49
|
|
| BLAKE2b-256 |
ad13102d7134743120db25e636ffb57a30818e95a416583dca83aadac9c5dd87
|
File details
Details for the file sphinx_markdown_builder-0.6.11-py3-none-any.whl.
File metadata
- Download URL: sphinx_markdown_builder-0.6.11-py3-none-any.whl
- Upload date:
- Size: 18.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
acfb94d6ee66c7a47da0ca0420578fa16f115812af25b8fd21755d5909aacf51
|
|
| MD5 |
b483504dd1f17445958e778015de99ea
|
|
| BLAKE2b-256 |
c97106b415631c2e494c80546073b46013d1715dceb3abe30bd63b34b4e7d9ca
|
