diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/processors/error-docs.js | 11 | ||||
| -rw-r--r-- | docs/config/templates/error.template.html | 17 | ||||
| -rw-r--r-- | docs/docs.config.js | 3 | 
3 files changed, 30 insertions, 1 deletions
| diff --git a/docs/config/processors/error-docs.js b/docs/config/processors/error-docs.js index 80a7b996..3fed96c5 100644 --- a/docs/config/processors/error-docs.js +++ b/docs/config/processors/error-docs.js @@ -8,8 +8,15 @@ module.exports = {    runAfter: ['tags-extracted'],    init: function(config, injectables) {      injectables.value('errorNamespaces', {}); + +    var minerrInfoPath = config.get('processing.errors.minerrInfoPath'); +    if ( !minerrInfoPath ) { +      throw new Error('Error in configuration: Please provide a path to the minerr info file (errors.json) ' + +        'in the `config.processing.errors.minerrInfoPath` property'); +    } +    injectables.value('minerrInfo', require(minerrInfoPath));    }, -  process: function(docs, partialNames, errorNamespaces) { +  process: function(docs, partialNames, errorNamespaces, minerrInfo) {      // Create error namespace docs and attach error docs to each      _.forEach(docs, function(doc) { @@ -32,6 +39,8 @@ module.exports = {          namespaceDoc.errors.push(doc);          doc.namespace = namespaceDoc; +        doc.formattedErrorMessage = minerrInfo.errors[doc.namespace.name][doc.name]; +        }      }); diff --git a/docs/config/templates/error.template.html b/docs/config/templates/error.template.html new file mode 100644 index 00000000..f48b397b --- /dev/null +++ b/docs/config/templates/error.template.html @@ -0,0 +1,17 @@ +{% extends "base.template.html" %} + +{% block content %} +<h1>Error: {$ doc.id $} +  <div><span class='hint'>{$ doc.fullName $}</span></div> +</h1> + +<div> +    <pre class="minerr-errmsg" error-display="{$ doc.formattedErrorMessage $}">{$ doc.formattedErrorMessage $}</pre> +</div> + +<h2>Description</h2> +<div class="description"> +  {$ doc.description | marked $} +</div> + +{% endblock %}
\ No newline at end of file diff --git a/docs/docs.config.js b/docs/docs.config.js index 536728fb..afe982fd 100644 --- a/docs/docs.config.js +++ b/docs/docs.config.js @@ -31,6 +31,9 @@ module.exports = function(config) {    });    config.set('processing.examples.dependencyPath', '../../..'); + +  config.set('processing.errors.minerrInfoPath', path.resolve(basePath, '../build/errors.json')); +    config.set('rendering.outputFolder', '../build/docs');    config.set('logging.level', 'info'); | 
