Provide documentation infrastructure
Created by: elbenfreund
We will use shinx
for documentation generation. Whilst there are several language specific documentation solutions common in the javascript ecosystem most of them focus on autogenerating API documentation, which we do not care too much about. If they will be required in future we may use one of the rst templates available to convert between JSDoc and rst. The advantage of using sphinx for all our documentation needs is that it is well tested as well as that we can reuse our existing generic project wide documentation (which is formated as *.rst).
The downside is that building the documentation requires additional python packages, but this can be mitigated by advocating usage of virtualenv
and a convenient make target (make develop
).
Our infrastructure should also provide documentation testing right from the start.