Prtksxna has uploaded a new change for review.
https://gerrit.wikimedia.org/r/276714
Change subject: docs: Use the standard way of generating documentation
......................................................................
docs: Use the standard way of generating documentation
* Move the files from the docs directory
* Remove the generate script
* Add npm task
Change-Id: I2b404e132aab0be563c7abb9145ab607242c94cd
---
M .gitignore
D docs/generate
R jsduck.categories.json
R jsduck.external.js
M jsduck.json
M package.json
6 files changed, 5 insertions(+), 8 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MultimediaViewer
refs/changes/14/276714/1
diff --git a/.gitignore b/.gitignore
index dcd7e21..c40aa38 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
-docs/js/
+docs/
node_modules/
diff --git a/docs/generate b/docs/generate
deleted file mode 100755
index 6b7c77b..0000000
--- a/docs/generate
+++ /dev/null
@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-set -e
-cd $(dirname $0)/..
-jsduck
diff --git a/docs/categories.json b/jsduck.categories.json
similarity index 100%
rename from docs/categories.json
rename to jsduck.categories.json
diff --git a/docs/external.js b/jsduck.external.js
similarity index 100%
rename from docs/external.js
rename to jsduck.external.js
diff --git a/jsduck.json b/jsduck.json
index 29a395d..a9be81f 100644
--- a/jsduck.json
+++ b/jsduck.json
@@ -1,12 +1,12 @@
{
"--title": "MultimediaViewer - Documentation",
- "--categories": "docs/categories.json",
+ "--categories": "jsduck.categories.json",
"--builtin-classes": true,
"--processes": "0",
"--warnings-exit-nonzero": true,
"--output": "docs",
"--": [
- "docs/external.js",
+ "jsduck.external.js",
"resources/mmv"
]
}
diff --git a/package.json b/package.json
index 72eb4aa..c78fc19 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,8 @@
{
"private": true,
"scripts": {
- "test": "grunt test"
+ "test": "grunt test",
+ "doc": "jsduck"
},
"devDependencies": {
"grunt": "0.4.5",
--
To view, visit https://gerrit.wikimedia.org/r/276714
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I2b404e132aab0be563c7abb9145ab607242c94cd
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MultimediaViewer
Gerrit-Branch: master
Gerrit-Owner: Prtksxna <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
