You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
132 lines
4.1 KiB
132 lines
4.1 KiB
Metadata-Version: 2.1
|
|
Name: sphinx-markdown-builder
|
|
Version: 0.5.4
|
|
Summary: sphinx builder that outputs markdown files
|
|
Home-page: https://github.com/codejamninja/sphinx-markdown-builder
|
|
Author: Jam Risser
|
|
Author-email: jam@codejam.ninja
|
|
License: MIT
|
|
Keywords: sphinx docs documentation markdown
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 4 - Beta
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: Topic :: Utilities
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Programming Language :: Python :: 2
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Description-Content-Type: text/markdown
|
|
Requires-Dist: html2text
|
|
Requires-Dist: pydash
|
|
Requires-Dist: sphinx
|
|
Requires-Dist: unify
|
|
Requires-Dist: yapf
|
|
|
|
# sphinx-markdown-builder
|
|
|
|
[](https://pypi.org/project/sphinx-markdown-builder)
|
|
[](https://pypi.org/project/sphinx-markdown-builder)
|
|
[](https://pypi.org/project/sphinx-markdown-builder)
|
|
[](https://github.com/codejamninja/sphinx-markdown-builder)
|
|
[](https://liberapay.com/codejamninja/donate)
|
|
[](https://liberapay.com/codejamninja/donate)
|
|
|
|
> sphinx builder that outputs markdown files
|
|
|
|
Please ★ this repo if you found it useful ★ ★ ★
|
|
|
|
If you want frontmatter support please use [sphinx-jekyll-builder](https://github.com/codejamninja/sphinx-jekyll-builder)
|
|
|
|
|
|
## Built by Silicon Hills LLC
|
|
|
|
[](https://nuevesolutions.com)
|
|
|
|
Silicon Hills offers premium Node and React develpoment and support services. Get in touch at [nuevesolutions.com](https://nuevesolutions.com).
|
|
|
|
|
|
## Recommended Projects
|
|
|
|
* [sphinx-markdown-parser](https://github.com/codejamninja/sphinx-markdown-parser) - write markdown inside of docutils & sphinx projects
|
|
|
|
|
|
## Features
|
|
|
|
* Generates markdown
|
|
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
pip3 install sphinx-markdown-builder
|
|
```
|
|
|
|
|
|
## Dependencies
|
|
|
|
* [Python 3](https://www.python.org)
|
|
|
|
|
|
## Usage
|
|
|
|
Build markdown files with Makefile
|
|
|
|
```sh
|
|
make markdown
|
|
```
|
|
|
|
Build markdown files with `sphinx-build` command
|
|
|
|
```sh
|
|
cd docs
|
|
sphinx-build -M markdown ./ build
|
|
```
|
|
|
|
|
|
## Support
|
|
|
|
Submit an [issue](https://github.com/codejamninja/sphinx-markdown-builder/issues/new)
|
|
|
|
|
|
## Screenshots
|
|
|
|
[Contribute](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CONTRIBUTING.md) a screenshot
|
|
|
|
|
|
## Contributing
|
|
|
|
Review the [guidelines for contributing](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CONTRIBUTING.md)
|
|
|
|
|
|
## License
|
|
|
|
[MIT License](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/LICENSE)
|
|
|
|
[Jam Risser](https://codejam.ninja) © 2018
|
|
|
|
|
|
## Changelog
|
|
|
|
Review the [changelog](https://github.com/codejamninja/sphinx-markdown-builder/blob/master/CHANGELOG.md)
|
|
|
|
|
|
## Credits
|
|
|
|
* [Jam Risser](https://codejam.ninja) - Author
|
|
* [Matthew Brett](https://github.com/matthew-brett/nb2plots/blob/master/nb2plots/doctree2md.py) - doctree2md
|
|
|
|
|
|
## Support on Liberapay
|
|
|
|
A ridiculous amount of coffee ☕ ☕ ☕ was consumed in the process of building this project.
|
|
|
|
[Add some fuel](https://liberapay.com/codejamninja/donate) if you'd like to keep me going!
|
|
|
|
[](https://liberapay.com/codejamninja/donate)
|
|
[](https://liberapay.com/codejamninja/donate)
|
|
|
|
|