From 7d6d582ffc69597ef82e7eed7c34e27f71b4889e Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Mon, 25 Jul 2016 10:59:18 +0900 Subject: 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 --- docs/how-to-use-docs/documentation-example.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/how-to-use-docs') 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 '/docs/pre-hook.sh' which will be executed (using 'source') +once before all document build start. -- cgit 1.2.3-korg