diff options
author | 2016-12-08 17:08:58 +0100 | |
---|---|---|
committer | 2016-12-08 17:08:58 +0100 | |
commit | 514f743d819b593087edd684f08704db2eb2f980 (patch) | |
tree | 72d8447a65991c99c9a150a0e782bb27f5432923 /README.md | |
parent | 4d9820fd05d4ab2c3171e72388d784d4d7aeb05b (diff) |
add trick to webdocs_agl README.md
* add trick for local build of local build of the website.
Signed-off-by: Ronan <ronan.lemartret@iot.bzh>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -49,6 +49,19 @@ Alternatively, a Makefile can be used and defines the most common operations: - register at https://community.algolia.com/docsearch/ and update your apikey into conf/_config.yml +## trick + +- For the moment you can only build source documentation from github (automotive-grade-linux/docs-agl). +So if you want to test localy your modification before a "pull request", just change github path with: + +``` +export MY_GITHUB_ACCOUNT=XXX +find ../ -name fetched_files.yml -exec sed -i "s@automotive-grade-linux/docs-agl@$MY_GITHUB_ACCOUNT/docs-agl@g" {} \; +make clean; +make fetch; +make build; +make serve; +``` ## bugs |