sphinx markdown output
Project description
sphinx markdown output
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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42621843314dc791a9ecc25d6783cb0e64ed0704143349448de3b3dc6ec57baf |
|
MD5 | 8c5659ca76051b81514fef7561e41fec |
|
BLAKE2b-256 | 22f27c2b080a84786966c8651a75220e56c1af667edab908321c4180d415ebf2 |
Hashes for sphinx_markdown_builder-0.0.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a160c4987b20ed94f8e3edacf59d760fbc4c07afc40b8185cb7bbf0222f23abc |
|
MD5 | dd0251a40f6249bc7c339df053fe66d1 |
|
BLAKE2b-256 | a90dc04a1006b4166432fa04649637ba93663c67e7997207f64804adb4306958 |