mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-30 10:26:03 +00:00
7b7c948bf6
This adds the wmf theme styles to our jsdoc as can be seen on https://doc.wikimedia.org/Parsoid/master/. There is a caveat with this though. jsdoc-wmf-theme adds warnings for unlinked symbols (e.g. 'return {jQuery}') [1] which causes the jsdoc doc generation to fail since it is set to fail on warnings (we have it configured with `pedantic: true`). If we add the jsdoc-wmf-theme, we will need to be stricter about our symbol usage which could be a good thing or just be tedious and annoying. What do you think? [1] https://github.com/cscott/jsdoc-wmf-theme/blob/master/publish.js#L29 Bug: T239258 Change-Id: Icade62a278d7e685cbda28a8ca26a1b703e64f19
20 lines
320 B
JSON
20 lines
320 B
JSON
{
|
|
"opts": {
|
|
"destination": "docs/js",
|
|
"package": "package.json",
|
|
"pedantic": true,
|
|
"readme": "README.md",
|
|
"recurse": true,
|
|
"template": "node_modules/jsdoc-wmf-theme"
|
|
},
|
|
"source": {
|
|
"include": [ "resources" ]
|
|
},
|
|
"templates": {
|
|
"cleverLinks": true,
|
|
"default": {
|
|
"useLongnameInNav": true
|
|
}
|
|
}
|
|
}
|