sphinx builder that outputs markdown files
Project description
sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
If you want frontmatter support please use sphinx-jekyll-builder
Features
Generates markdown
Installation
pip3 install sphinx-markdown-builder
Dependencies
Usage
Load extension in configuration.
conf.py
extensions = [
'sphinx_markdown_builder'
]
If using recommonmark, make sure you explicitly ignore the build files as they will conflict with the system.
conf.py
exclude_patterns = [
'build/*'
]
Build markdown files with Makefile
make markdown
Build markdown files with sphinx-build command
cd docs
sphinx-build -M markdown ./ build
Support
Submit an issue
Screenshots
Contribute a screenshot
Contributing
Review the guidelines for contributing
License
Jam Risser © 2018
Changelog
Review the changelog
Credits
Jam Risser - Author
Matthew Brett - doctree2md
Support on Liberapay
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
Add some fuel if you’d like to keep me going!
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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7505215bc871673fead8270b6db55f079eba636d31c2f71caa245358ca48b1d |
|
MD5 | 79d1a29b320c2cea6756ff6b5c5992da |
|
BLAKE2b-256 | 18b5c0076f5230242bdbed217ee79387219dec70a9344543174aaa1148e7f2c9 |
Hashes for sphinx_markdown_builder-0.4.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 418857a21e24badbbee6a9c6ed12f2bf9a95157ef74905164f324a8f90b66bc8 |
|
MD5 | aa958f492bf4975cc02042d97c2dab0d |
|
BLAKE2b-256 | f76d992cabe73a6b3ec943d6fec3f0b3d6a50c501e3b115f6ed4813b557fbe1a |