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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84599826d4742eda6f2d59b8503cc2b82dd675343c168a89cef9222fd46c0372 |
|
MD5 | 3a0b8f33e410b3362225198f5ec2bdcf |
|
BLAKE2b-256 | 550ceb02493491591bbb9425f60e90e70fb8d6f6636f30547c5ed95fefce6581 |
Hashes for sphinx_markdown_builder-0.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb94ad3ee81868106dee9ddcaf38b4d5af6b0f07430d2760ef75bfc2795d2dfc |
|
MD5 | ade6f93757a57ccd51b407435e07f5a8 |
|
BLAKE2b-256 | a7bd7ed32edaf7fa1cac9a54b612b24e8d9d117ea9b96c2240eddff71f84c492 |