Deploy updated jsdocs to pubs and docs.marklogic.com

[wooldridge]

Generate jsdocs content for the 2.0.0 release and deploy it to pubs and docs.marklogic.com. This should happen close to the time of the release so as to pick up all documentation changes for the release.

The jsdocs libraries are being updated for this release so there may be bumps to smooth over, see #363. E.g., need to make sure inline JavaScript is extracted from template files.

[kcoleman-marklogic]

Once you merge your changes to the develop branch, they'll get picked up automatically by the doc build and we can see if there are problems.

[wooldridge]

Merged jsdoc updates in PR #374.

[wooldridge]

When deployed to pubs, index.html page looks OK but clicking through to another page throws the following error:

docstrap.lib.js:formatted:2534 Uncaught DOMException: Failed to set the 'innerHTML' property on 'Element': The provided markup is invalid XML, and therefore cannot be inserted into an XML document.
    at Function.buildFragment (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:2:20957)
    at Function._.parseHTML (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:3:16626)
    at _.fn.init (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:2:709)
    at _ (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:1:9644)
    at HTMLDivElement.<anonymous> (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/toc.js:151:16)
    at Function.each (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:1:12113)
    at _.fn.init.each (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:1:10090)
    at _.fn.init.$.fn.toc (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/toc.js:148:17)
    at XMLDocument.<anonymous> (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/extracted/highlight.js:43:15)
    at k (http://pubs.marklogic.com:8011/9.0/jsdoc/scripts/docstrap.lib.js:2:3465)buildFragment @ docstrap.lib.js:formatted:2534_.parseHTML @ docstrap.lib.js:formatted:3826_.fn.init @ docstrap.lib.js:formatted:1580_ @ docstrap.lib.js:formatted:493(anonymous function) @ toc.js:151each @ docstrap.lib.js:formatted:620each @ docstrap.lib.js:formatted:519$.fn.toc @ toc.js:148(anonymous function) @ highlight.js:43k @ docstrap.lib.js:formatted:1713fireWith @ docstrap.lib.js:formatted:1769ready @ docstrap.lib.js:formatted:1863g @ docstrap.lib.js:formatted:47

Note the error text The provided markup is invalid XML. Most likely need to rewrite some generated HTML (probably in toc.js) to make it conform to XML standards. Or move some embedded JS to a separate file as this is known to cause problems (although AFAICT all the embedded JS from the original template has been moved).

[kcoleman-marklogic]

This did not fix the problem, unfortunately.

[wooldridge]

The error is being caused by HTML generation in the following script file:

https://github.com/docstrap/docstrap/blob/master/template/static/scripts/docstrap.lib.js

and not in a template or script file higher up that would be more straightforward to diagnose and edit.

My current plan is to try previous versions of the docstrap template. I hope to find a version that plays nicely with our system and its requirements for valid XML.

[jmakeig]

I still don't understand why docstrap is concerned with XML. Are you serving the page as application/xhtml+xml?

[kcoleman-marklogic]

Docstrap doesn't care about XML, but the app that hosts the docs is a MarkLogic app and it cares very much about XML.

[wooldridge]

Switched from v1.3.0 of the docstrap template to v1.1.4 and still see the exact same error from the pubs server. (Thanks so much @kcoleman-marklogic for helping with the pubs server setup.) Will try going back further.

[wooldridge]

Tried docstrap template v1.0.5, same error.