Noms Documentation

#!/usr/bin/env python

# Copyright 2016 Attic Labs, Inc. All rights reserved.
# Licensed under the Apache License, version 2.0:
# http://www.apache.org/licenses/LICENSE-2.0

'''
This script builds the JS SDK documentation and puts the generated files
in $WORKSPACE/src/github.com/attic-labs/noms/js/noms/generated-docs.
'''

import copy
import json
import os
import subprocess

index_html_content = """
<!doctype html>
<title>Noms Documentation</title>
<h1>Noms Documentation</h1>
<h3><a href="https://godoc.org/github.com/attic-labs/noms">Go</a></h3>
<h3><a href="js/">JavaScript</a></h3>
"""

def call_with_env_and_cwd(cmd, cwd):
    print(cmd)
    proc = subprocess.Popen(cmd, env=os.environ, cwd=cwd, shell=False)
    proc.wait()
    assert proc.returncode == 0

def main():
    # Workspace is the root of the builder, e.g. "/var/lib/jenkins/workspace/builder".
    workspace = os.getenv('WORKSPACE')
    assert workspace

    noms_dir = os.path.join(workspace, 'src/github.com/attic-labs/noms')
    noms_js_dir = os.path.join(noms_dir, 'js/noms')

    call_with_env_and_cwd(['npm', 'install'], noms_js_dir)
    call_with_env_and_cwd(['npm', 'run', 'build-docs'], noms_js_dir)

    with open(os.path.join(noms_js_dir, 'generated-docs', 'index.html'), 'w') as f:
        f.write(index_html_content)

if __name__ == '__main__':
    main()