sphinx-npm

0.2.0 • Public • Published

sphinx-npm

A launcher for Sphinx documentation generator which provides sane defaults for configuring npm packages such as:

  • it defaults to run Sphinx without configuration file
  • it defaults to use singlehtml builder which builds
  • it takes author, project, version and release options from corresponding fields in a package.json
  • it defaults master_doc to README.rst file in a root of a packagea

You can override any of these by using corresponding command line options, usage is as follows:

sphinx-npm <PACKAGE DIR> <OUTPUT DIR>

Readme

Keywords

none

Package Sidebar

Install

npm i sphinx-npm

Weekly Downloads

2

Version

0.2.0

License

MIT

Last publish

Collaborators

  • andreypopp