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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2746e8c70574969583a45dc88e7489768695870e69ff5e8d2c56717b16f9299 |
|
MD5 | 3a40ff4476a3c86788a2c5a0e09d2ff9 |
|
BLAKE2b-256 | 0c0dbe6b859d92038179d13d30729da22380004ac5e38a7ee3f797780ae67d2a |
Hashes for sphinx_markdown_builder-0.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c7c90a02d0d25cd6c21f0aa77d379925bd9b0662866e7f4acce3477bb1f2f36 |
|
MD5 | 31f4e02a491c9d9a072679364a3f1e68 |
|
BLAKE2b-256 | db8f6d2092567786ae6df0e07c51b872325e7b8cc6c5eebc09b1116b1bd684bb |