[ci] Add generate docs to ci and README

.github/workflows/build_test.yml

@@ -37,5 +37,9 @@ jobs:
         run: |
           source "$HOME/.profile"
           mpm package prove
+      - name: generate-docs-test
+        run: |
+          source "$HOME/.profile"
+          bash ./scripts/generate-docs.sh
       - name: check changed files
         run: bash ./scripts/changed-files.sh

README.md

@@ -48,7 +48,9 @@ Contributions in the following are welcome:
 1. Add New Move module to `sources` dir, such as `MyModule.move`.
 2. Write Move code and add unit test in the module file.
 3. Add a spec test [spectests](../spectests), such as: `test_my_module.move`.
-4. Run the spec test `mpm spectest test_my_module.move `
+4. Run the spec test `mpm spectest test_my_module.move `.
+5. Run script `./script/generate-docs.sh` for generate documents.
+6. Commit the changes and create a pull request.
 
 If you are not sure that the module belongs to starcoin-framework, please submit it to [starcoin-framework-commons](https://github.com/starcoinorg/starcoin-framework-commons) first.
 

scripts/generate-docs.sh

@@ -9,5 +9,6 @@ SCRIPT_PATH="$( cd "$( dirname "$0" )" >/dev/null 2>&1 && pwd )"
 cd "$SCRIPT_PATH/.." || exit
 
 mpm package build --doc
+rm -f docs/latest/*
 cp -r build/StarcoinFramework/docs/* docs/latest/
 git add docs/latest