summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-07-25 10:59:18 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-07-25 11:22:01 +0900
commit7d6d582ffc69597ef82e7eed7c34e27f71b4889e (patch)
treed13adef8ad2670456781e4fabe964b05a551e34c /docs
parentf59a2d4f1c5655e5ec4f3ab5fe70932ac2fa94f0 (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>
Diffstat (limited to 'docs')
-rw-r--r--docs/how-to-use-docs/documentation-example.rst8
1 files changed, 8 insertions, 0 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.