diff --git a/build/README.md b/build/README.md index 575685281..88f1ba8de 100644 --- a/build/README.md +++ b/build/README.md @@ -1,8 +1,8 @@ This directory contains the scripts used to build and test Shaka Player. These scripts can run on any platform that supports python v2.7 and JRE 8+. -* `all.py` simply runs `gendeps.py`, `check.py`, and `build.py`. Will forward - `--force` to `build.py`. +* `all.py` simply runs `gendeps.py`, `check.py`, `docs.py`, and `build.py`. + It will forward `--force` to `build.py`. * `build.py` builds the compiled library. This will fail if there are syntax or type errors. * `check.py` will check all the files for style violations and will check the diff --git a/build/all.py b/build/all.py index fcf306b38..b121f313a 100755 --- a/build/all.py +++ b/build/all.py @@ -19,6 +19,7 @@ import argparse import build import check +import docs import gendeps import shakaBuildHelpers @@ -62,6 +63,11 @@ def main(args): if code != 0: return code + docs_args = [] + code = docs.build_docs(docs_args) + if code != 0: + return code + build_args = ['--name', 'compiled', '+@complete'] if parsed_args.force: diff --git a/docs/tutorials/welcome.md b/docs/tutorials/welcome.md index bc3ae124a..297e3e29a 100644 --- a/docs/tutorials/welcome.md +++ b/docs/tutorials/welcome.md @@ -56,7 +56,7 @@ cd shaka-player ``` -#### Compile the library +#### Compile the library and generate the docs ```sh python build/all.py @@ -67,15 +67,7 @@ The output is: * dist/shaka-player.compiled.debug.js (debug bundle) * dist/shaka-player.compiled.externs.js (generated externs, for Closure-based projects) - - -#### Generate the documentation - -```sh -python build/docs.py -``` - -The output will be in `docs/api/`. + * docs/api/index.html (generated documentation) #### Run the tests diff --git a/package.json b/package.json index a46380dd2..03522a599 100644 --- a/package.json +++ b/package.json @@ -57,6 +57,6 @@ }, "license": "Apache-2.0", "scripts": { - "prepublish": "in-publish && python build/checkversion.py && python build/docs.py && python build/all.py --force || not-in-publish" + "prepublish": "in-publish && python build/checkversion.py && python build/all.py --force || not-in-publish" } }