mirror of
https://github.com/Bismuth-Forge/bismuth.git
synced 2024-11-04 13:37:43 +03:00
docs: basic documentation generation
This commit is contained in:
parent
847942e780
commit
74a3e702b4
3
Makefile
3
Makefile
@ -15,6 +15,9 @@ stop:
|
||||
test:
|
||||
npm test
|
||||
|
||||
docs:
|
||||
npm run docs
|
||||
|
||||
package:
|
||||
npm run package
|
||||
|
||||
|
@ -7,4 +7,4 @@ KWINPKG_FILE="${npm_package_name}-${npm_package_version}.kwinscript"
|
||||
rm -f "$KWINPKG_FILE"
|
||||
|
||||
# Create new installable package
|
||||
7z a -tzip "$KWINPKG_FILE" ./$npm_package_config_build_dir/*
|
||||
7z a -tzip "$KWINPKG_FILE" ./$npm_package_config_build_dir/contents/ ./$npm_package_config_build_dir/metadata.desktop
|
||||
|
@ -11,9 +11,9 @@
|
||||
"node_script": "krohnkite.js",
|
||||
"build_dir": "build"
|
||||
},
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"mocha": "^6.0.0"
|
||||
"mocha": "^6.0.0",
|
||||
"typedoc": "^0.21.6"
|
||||
},
|
||||
"scripts": {
|
||||
"clean": "bin/clean.sh",
|
||||
@ -26,6 +26,7 @@
|
||||
"preinstall": "npm run package",
|
||||
"install": "bin/install.sh",
|
||||
"uninstall": "bin/uninstall.sh",
|
||||
"docs": "npx typedoc --out $npm_package_config_build_dir/docs",
|
||||
"test": "mocha 'test/*.spec.js'"
|
||||
},
|
||||
"repository": {
|
||||
|
@ -10,6 +10,11 @@
|
||||
"alwaysStrict": true,
|
||||
"strict": true
|
||||
},
|
||||
"typedocOptions": {
|
||||
"entryPoints": [
|
||||
"src"
|
||||
]
|
||||
},
|
||||
"include": [
|
||||
"src/**/*",
|
||||
"test/**/*"
|
||||
|
Loading…
Reference in New Issue
Block a user