Добавление статических файлов в JSDoc

Question

Мне нужно добавить статические ресурсы для учебных пособий в JSDoc. Структура моего проекта: учебники

PROJECT ROOT 
| 
| 
---> Project directory A 
---> Project directory B 
---> ... 
| 
---> Tutorials 
    | 
    | 
    | 
    -------->IMG 

Каталог/IMG содержит статические ресурсы, которые я хочу, чтобы включить. Мой файл конф является:

{ 
    "tags": { 
    "allowUnknownTags": true, 
    "dictionaries": [ 
     "jsdoc", 
     "closure" 
    ] 
    }, 
    "source": { 
    "include": [ 
     "modules/abstractModel.js", 
     "modules/abstractMediator.js", 
     "modules/abstractTemplate.js", 
     "modules/abstractView.js", 
     "modules/modelEvent/modelEvent.js" 
    ], 
    //"exclude": ["http/httpSession.js", "http/wyPlayWrapper.js", "util/service.js"], 
    "includePattern": ".+\\.js(doc)?$", 
    "excludePattern": "(^|\\/|\\\\)_" 
    }, 
    "plugins": [], 

    "templates": { 
    "default": { 
     "staticFiles": { 
     "include": ["./trunk/tutorials/img/"] 
     } 
    } 
    } 
} 

Это командная строка я использую для получения документации (выполненную из оболочки в ROOT папку проекта):

JSDoc -c конф/jsdoc.conf -u учебники/-d ./docs. учебники/README.md --verbose

Но любой статический файл импортируется в папку Docs, и я не могу использовать любое изображение в учебнике. Любое предложение приветствуется.

Answer 1

Функция кажется очень глючной, по крайней мере, в выпуске JSDoc 3.3.0-dev (понедельник, 30 июня 2014 00:12:06 GMT).

Прежде всего, правильный синтаксис, кажется:

{ 
    .... 

    "templates": { 
    "default": { 
     "staticFiles": { 
     "paths": ["./tutorials/img/"] 
     } 
    } 
    } 
} 

Затем в файле JSDoc/шаблоны/по умолчанию/publish.js, я изменил линию ~ 525 от

var sourcePath = fs.toDir(filePath); 

к

var sourcePath = fs.toDir(fileName); 

Таким образом, файлы учебники/IMG являются скопированный в docs outdir. Это не лучшее решение (подкаталоги не копируются), но для моих целей это достаточно.