Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

tools: Add wrapper tool 'build-docs' for building documentation.

This commit is contained in:
Cory Lynch 2017-06-14 22:15:47 -04:00 committed by Tim Abbott
parent 458fcfa646
commit 3bc369f1cf
3 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/README.md
View File

@ -38,8 +38,7 @@ Zulip development environment provisioning, and you can build the
documentation using: documentation using:
``` ```
cd docs/ ./tools/build-docs
make html
``` ```
and then opening `http://127.0.0.1:9991/docs/index.html` in your and then opening `http://127.0.0.1:9991/docs/index.html` in your

5
tools/build-docs Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
cd "$(dirname "$0")"/../docs
rm -rf _build
make html

6
tools/test-documentation
View File

@ -13,9 +13,9 @@ case $1 in
;; ;;
esac esac
cd "$(dirname "$0")"/../docs cd "$(dirname "$0")"/..
make html ./tools/build-docs
cd ../tools/documentation_crawler cd ./tools/documentation_crawler
echo -en "\033[0;94m" echo -en "\033[0;94m"
echo "Testing links in documentation..." echo "Testing links in documentation..."