sphinx builder that outputs markdown files
Project description
PyPI PyPI - Downloads PyPI - Python Version GitHub stars
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f39d436ab6fd25e32697e8e2387dd2322aceb65e1a1f9aeeca794bc5de5d531 |
|
MD5 | 37968b9c949c11b3dfa5c177c5e6b60e |
|
BLAKE2b-256 | beea00d2d168f0390ca3739ce63ff23de444b1aecee35f3fdae0fa89c93fbecc |
Hashes for sphinx_markdown_builder-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb057e424095e592f732427b45958274e57f6389adaf3a1fe06648fd3255e9d8 |
|
MD5 | 7aa43e0f3f13000e5bec2eaaee975d59 |
|
BLAKE2b-256 | 1bf3e15b384ff54aa591a28a6f8b0ab5b9224b1a57844a6fcba55d4e8b1f2aa3 |