clayrisser / generator-sphinx

Yeoman generator for sphinx

generator-sphinx

Yeoman generator for sphinx

Please ★ this repo if you found it useful ★ ★ ★

Features

• Build html docs
• Build man pages
• Build latex project
• Build pdf docs
• Choose from multiple themes
• Choose custom latex type
• Supports multiple sphinx domains
• Markdown support
• Supports math expressions

Installation

npm install -g yo generator-sphinx

Dependencies

• NodeJS
• GNU Make
• Python 3
• Virtualenv
• Latexmk

Usage

yo sphinx

Serve locally

make serve

Build

make build

Build help

make help

Build html

make html

Build man page

make man

Build latex

make latex

Build pdf

make latexpdf

Support

Submit an issue

Screenshots

Contribute a screenshot

Contributing

Review the guidelines for contributing

License

MIT License

Jam Risser © 2018

Changelog

Review the changelog

Credits

• Jam Risser - Author

Support on Beerpay (actually, I drink coffee)

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!