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
Chris Wrench - Markdown Writer
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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94732a5fad21dfa51117cf69029074e3af00ec43613196f9478a72e2abe9eb9b |
|
MD5 | d2e60ad58e6292a7125b5bf9266f2024 |
|
BLAKE2b-256 | 2baeb7cc623743c8008fcf892238afab10e85db7882fcc21c922507b39c60619 |
Hashes for sphinx_markdown_builder-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64d4b38f5b348db0852c1234bed50364a6a128d27a88ccb2fe8268aac4013d5a |
|
MD5 | 1d62fd2e5bfe0a8b79be0999dd160a3d |
|
BLAKE2b-256 | 0c3e14b0503853b225d39c0ac7cfe07ec70e51895802c2f9c766f57bfd91cb78 |