You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
38 lines
1.1 KiB
38 lines
1.1 KiB
|
|
var packageDef = require('../package.json');
|
|
|
|
function buildDocs() {
|
|
|
|
console.log('Building Leaflet documentation with Leafdoc');
|
|
|
|
var LeafDoc = require('leafdoc');
|
|
var doc = new LeafDoc({
|
|
templateDir: 'build/leafdoc-templates',
|
|
showInheritancesWhenEmpty: true,
|
|
leadingCharacter: '@'
|
|
});
|
|
|
|
// Note to Vladimir: Iván's never gonna uncomment the following line. He's
|
|
// too proud of the little leaves around the code.
|
|
//doc.setLeadingChar('@');
|
|
|
|
// Leaflet uses a couple of non-standard documentable things. They are not
|
|
// important enough to be classes/namespaces of their own, and should
|
|
// just be listed in a table like the rest of documentables:
|
|
doc.registerDocumentable('pane', 'Map panes');
|
|
doc.registerDocumentable('projection', 'Defined projections');
|
|
doc.registerDocumentable('crs', 'Defined CRSs');
|
|
|
|
doc.addFile('build/docs-index.leafdoc', false);
|
|
doc.addDir('src');
|
|
doc.addFile('build/docs-misc.leafdoc', false);
|
|
|
|
var out = doc.outputStr();
|
|
|
|
var fs = require('fs');
|
|
|
|
fs.writeFileSync('dist/reference-' + packageDef.version + '.html', out);
|
|
}
|
|
|
|
module.exports = buildDocs;
|