sphinx builder that outputs markdown files
Project description
sphinx builder that outputs markdown files
Please ★ this repo if you found it useful ★ ★ ★
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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09966af51eac8496a297cc4dcda72afb85bc0900684f8afbbaf1435f94c52f04 |
|
MD5 | d3e1f683d6467fa4517995cce264a58a |
|
BLAKE2b-256 | 4630aea18e0181519e5b15e649ef26f307756be3660fc94440a93fc6fba9eebb |
Hashes for sphinx_markdown_builder-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 234cf2513c97dcfd810e87edaa63cb1685568d1e7136839ea293610528447a00 |
|
MD5 | d5b55e33019f67fcf3a6dc002462e227 |
|
BLAKE2b-256 | 8ec698d9150d4efda10c49b9df52203cef02e80403c035ca30cc6b23f8927e7e |