Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/clayrisser/generator-sphinx

Yeoman generator for sphinx
https://github.com/clayrisser/generator-sphinx

generator readthedocs sphinx yeoman

Last synced: 20 days ago
JSON representation

Yeoman generator for sphinx

Host: GitHub
URL: https://github.com/clayrisser/generator-sphinx
Owner: clayrisser
License: mit
Created: 2018-03-11T03:33:37.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2023-10-03T00:30:30.000Z (about 1 year ago)
Last Synced: 2024-10-06T08:41:09.185Z (about 1 month ago)
Topics: generator, readthedocs, sphinx, yeoman
Language: JavaScript
Size: 821 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

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)