Merge pull request #287 from kelsos/documentation

Adds automatic documentation generation

.circleci/config.yml

@@ -126,6 +126,17 @@ jobs:
           paths:
             - ./*
 
+  generate_documentation:
+    executor: base-executor
+    working_directory: *sdk_working_dir
+    steps:
+      - attach_workspace: *attach_options
+      - run: cd ../docs && ./generate_documentation.sh
+      - persist_to_workspace:
+          root: ~/src/
+          paths:
+           - ./raiden-dapp/dist/docs
+
   deploy_gh_pages:
     executor: base-executor
     working_directory: *dapp_working_dir
@@ -164,10 +175,17 @@ workflows:
           requires:
             - lint_dapp
             - build_dapp
-      - deploy_gh_pages:
+      - generate_documentation:
           requires:
             - test_dapp
           filters:
             branches:
               only:
                 - master
+      - deploy_gh_pages:
+          requires:
+            - generate_documentation
+          filters:
+            branches:
+              only:
+                - master

docs/config.js

@@ -0,0 +1,17 @@
+const sidebar = require('./api-sidebar');
+
+module.exports = {
+    title: 'Raiden Light Client SDK',
+    description: 'API Documentation for the Raiden Light Client SDK',
+    base: '/docs/',
+    themeConfig: {
+        repo: 'raiden-network/light-client',
+        displayAllHeaders: true,
+        sidebar: sidebar,
+        lastUpdated: 'Last Updated',
+        nav: [
+            { text: 'Raiden Network', link: 'https://raiden.network/' },
+            { text: 'Developer Portal', link: 'https://developer.raiden.network/' }
+        ]
+    }
+};

docs/generate_documentation.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+cd ../raiden-ts
+
+if [[ -d './docs' ]]
+then
+ rm -rf docs
+fi
+
+npm run docs:generate
+
+[[ -d 'docs/.vuepress' ]] || mkdir docs/.vuepress
+[[ -d 'docs/.vuepress/styles' ]] || mkdir docs/.vuepress/styles
+
+cp ../docs/config.js docs/.vuepress/config.js
+cp ../docs/palette.styl docs/.vuepress/styles/palette.styl
+
+npm run docs:build
+
+if [[ ! -d '../raiden-dapp/dist/' ]]
+then
+    echo 'The dApp dist directory was not available'
+    exit 1;
+fi
+
+[[ ! -d '../raiden-dapp/dist/docs' ]] || rm -rf ../raiden-dapp/dist/docs
+
+cp -r docs/.vuepress/dist ../raiden-dapp/dist/docs

docs/palette.styl

@@ -0,0 +1 @@
+$accentColor = #28a5c8

raiden-ts/.gitignore

@@ -5,3 +5,4 @@ contracts/
 
 *.vim
 .localstorage
+docs