summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs/how-to-use-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.