Merge pull request #1052 from aeternity/feature/build-docs-automatically

Build docs automatically using Travis
aeternity · Oct 26, 2020 · 6475357 · 6475357
2 parents 139ff8a + 7c935a2
commit 6475357
Show file tree

Hide file tree

Showing 54 changed files with 25 additions and 6,533 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,8 @@ node_modules
 .tern-project
 .dir-locals.el
 /dist
+/docs/api*
+/docs/examples
 /.envrc
 /yarn-error.log
 .idea

diff --git a/.travis.yml b/.travis.yml
@@ -30,6 +30,16 @@ jobs:
         - npm run build
         - npm run test:unit
         - npm run report-coverage
+        - npm run docs:docco
+        - npm run docs:api
+      deploy:
+        - provider: pages
+          skip_cleanup: true
+          github_token: $GITHUB_TOKEN
+          keep_history: true
+          local_dir: docs
+          on:
+            branch: develop
     - stage: Integration tests
       name: Channel, accounts
       script:

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,7 @@
-# Guides
+# JavaScript SDK Documentation
+
+## ⚠️ Disclaimer
+We're doing our best to keep the documentation up to date, but [please let us know if you see some out-of-date file](https://github.com/aeternity/aepp-sdk-js/issues/new). Thanks!
 
 ## Intro
 There are three different ways of incorporating aepp-sdk-js into your project, depending on the particular scenario:
@@ -55,5 +58,7 @@ You can use this URL with any releasee on [npmjs](https://www.npmjs.com/package/
  - [How to build Wallet app/extension](guides/how-to-build-an-wallet-app-or-extension.md)
  - [How to build Aepp](guides/how-to-build-aepp-using-new-wallet-api.md)
 
+## [API Reference](api.md)
+
 ## Examples
-Check out our [Examples](../examples/README.md) for more.
+Check out our [Examples](examples/README.md) for more.
diff --git a/docs/api.md b/docs/api.md
diff --git a/docs/api/README.md b/docs/api/README.md
diff --git a/docs/api/account.md b/docs/api/account.md
diff --git a/docs/api/account/memory.md b/docs/api/account/memory.md
diff --git a/docs/api/account/selector.md b/docs/api/account/selector.md
diff --git a/docs/api/accounts.md b/docs/api/accounts.md