diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-07-25 10:59:18 +0900 |
|---|---|---|
| committer | Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-07-25 11:22:01 +0900 |
| commit | 7d6d582ffc69597ef82e7eed7c34e27f71b4889e (patch) | |
| tree | d13adef8ad2670456781e4fabe964b05a551e34c | |
| parent | f59a2d4f1c5655e5ec4f3ab5fe70932ac2fa94f0 (diff) | |
fix pre-hook
- execute pre-hook after required python package installed
- remove execution flag of docs/pre-hook.sh as it's unnecessary
- add howto document regarding 'Hooks'
Change-Id: Ib94888b018347ce8660d53db93dba3586c098948
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
| -rw-r--r-- | docs/how-to-use-docs/documentation-example.rst | 8 | ||||
| -rwxr-xr-x | scripts/docs-build.sh | 3 |
2 files changed, 9 insertions, 2 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst index 85133ad83..bbd710961 100644 --- a/docs/how-to-use-docs/documentation-example.rst +++ b/docs/how-to-use-docs/documentation-example.rst @@ -255,3 +255,11 @@ document build. .. _opnfvdocs/scripts/docs-build.sh: https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob;f=scripts/docs-build.sh; + +Hooks +===== + +The document builder script supports pre-hook. If you need to execute some +commands before starting to build process (e.g. generate API rst from codes), +create '<your repo>/docs/pre-hook.sh' which will be executed (using 'source') +once before all document build start. diff --git a/scripts/docs-build.sh b/scripts/docs-build.sh index afa68ec65..043fd1b94 100755 --- a/scripts/docs-build.sh +++ b/scripts/docs-build.sh @@ -190,13 +190,12 @@ fi virtualenv "$VENV_DIR" source "$VENV_DIR/bin/activate" +pip install -r "$OPNFVDOCS_DIR/etc/requirements.txt" if [ -e "$DOCS_DIR/pre-hook.sh" ]; then source "$DOCS_DIR/pre-hook.sh" fi -pip install -r "$OPNFVDOCS_DIR/etc/requirements.txt" - find $DOCS_DIR -name $INDEX_RST -printf '%h\n' | while read dir do name=$(generate_name $dir) |