UNPKG

typedoc-plugin-sphinx

Version:

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Sphinx's reStructuredText.

48 lines (47 loc) 1.47 kB
{ "name": "typedoc-plugin-sphinx", "version": "0.1.0", "description": "A plugin for TypeDoc that enables TypeScript API documentation to be generated in Sphinx's reStructuredText.", "main": "dist/index.js", "files": [ "dist/" ], "scripts": { "lint": "eslint ./src --ext .ts", "build": "rimraf dist && tsc && copyfiles --up 1 ./src/**/*.hbs ./dist/", "pretest": "yarn run demo:rst", "test": "jest --colors", "build-and-test": "yarn run build && yarn run test", "fixtures": "node ./tasks/fixtures.js", "demo": "yarn run build && yarn run demo:rst", "demo:rst": "typedoc --plugin . --options ./demo.options.json --out ./demo/rst" }, "author": "Jean-Philippe Steinmetz <info@acceleratxr.com>", "license": "MIT", "bugs": { "url": "https://gitlab.acceleratxr.com/composerjs/typedoc-plugin-sphinx/issues" }, "repository": "https://gitlab.acceleratxr.com/composerjs/typedoc-plugin-sphinx", "homepage": "https://gitlab.acceleratxr.com/composerjs/typedoc-plugin-sphinx", "keywords": [ "sphinx", "restructuredtext", "typescript", "documentation", "api", "typedocplugin", "typedoc" ], "peerDependencies": { "typedoc": ">=0.22.0" }, "dependencies": { "handlebars": "^4.7.7" }, "devDependencies": { "@types/node": "^17.0.39", "copyfiles": "^2.4.1", "typedoc": "^0.22.17", "typescript": "^4.7.3" } }