# generator-sphinx

**Repository Path**: mirrors_codejamninja/generator-sphinx

## Basic Information

- **Project Name**: generator-sphinx
- **Description**: Yeoman generator for sphinx
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# generator-sphinx

[![Beerpay](https://beerpay.io/jamrizzi/generator-sphinx/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/generator-sphinx)
[![Beerpay](https://beerpay.io/jamrizzi/generator-sphinx/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/generator-sphinx?focus=wish)
[![GitHub stars](https://img.shields.io/github/stars/jamrizzi/generator-sphinx.svg?style=social&label=Stars)](https://github.com/jamrizzi/generator-sphinx)

Yeoman generator for sphinx

![](assets/generator-sphinx.png)

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

```sh
npm install -g yo generator-sphinx
```


## Dependencies

* [NodeJS](https://nodejs.org)
* [GNU Make](https://www.gnu.org/software/make)
* [Python 3](https://www.python.org)
* [Virtualenv](https://virtualenv.pypa.io)
* [Latexmk](http://mg.readthedocs.io/latexmk.html)


## Usage

```sh
yo sphinx
```

#### Serve locally

```sh
make serve
```

#### Build
```sh
make build
```

#### Build help

```sh
make help
```

#### Build html

```sh
make html
```


#### Build man page

```sh
make man
```


#### Build latex

```sh
make latex
```


#### Build pdf

```sh
make latexpdf
```


## Support

Submit an [issue](https://github.com/jamrizzi/generator-sphinx/issues/new)


## Screenshots

[Contribute](https://github.com/jamrizzi/generator-sphinx/blob/master/CONTRIBUTING.md) a screenshot


## Contributing

Review the [guidelines for contributing](https://github.com/jamrizzi/generator-sphinx/blob/master/CONTRIBUTING.md)


## License

[MIT License](https://github.com/jamrizzi/generator-sphinx/blob/master/LICENSE)

[Jam Risser](https://jam.jamrizzi.com) © 2018


## Changelog

Review the [changelog](https://github.com/jamrizzi/generator-sphinx/blob/master/CHANGELOG.md)


## Credits

* [Jam Risser](https://jam.jamrizzi.com) - Author


## Support on Beerpay (actually, I drink coffee)

A ridiculous amount of coffee :coffee: :coffee: :coffee: was consumed in the process of building this project.

[Add some fuel](https://beerpay.io/jamrizzi/generator-sphinx) if you'd like to keep me going!

[![Beerpay](https://beerpay.io/jamrizzi/generator-sphinx/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/generator-sphinx)
[![Beerpay](https://beerpay.io/jamrizzi/generator-sphinx/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/generator-sphinx?focus=wish)