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.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c6cdd0af54c04eb43d93245d29d44e57652ac6737e273b544e998dc01f0f827 |
|
MD5 | 86c734c7ac461f92cc159d102a516766 |
|
BLAKE2b-256 | 686a2e2aac0c8a98d64b8e255b278c71c0ef124588a09d46f7c960ed97187584 |
Hashes for sphinx_markdown_builder-0.0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 685815592741c6e21f2ea72453a8dda2aa988f0302d4d94cb29b1a5f4d1a3172 |
|
MD5 | 0bf92a40276d1e4879b6c2eb9a8d7893 |
|
BLAKE2b-256 | a17aa939ebd8738ae13cece044998660314a3c8220314c97d1d23ea87cb295d4 |