aboutsummaryrefslogtreecommitdiffstats
path: root/docs/pre-hook.sh
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-07-25 11:37:16 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-07-25 11:37:16 +0900
commit7bd5e5cf241af264fee181adc50ed3a110db13a6 (patch)
tree8facf45f6e19f8b9dad83966da6e00d68ce1d462 /docs/pre-hook.sh
parent6ce3a97548e95a62cf39f37c76bf5b618f5575c4 (diff)
[docs] pre-hook for apidocs
This patch adds pre-hook script which is newly supported by opnfvdocs and can be used to generate apidocs in yardstick. This patch also updates .gitignore ; - remove '/releng/' as it isn't needed any more - add '/docs/apidocs/yardstick*.rst' as those files are generated by sphinx and aren't needed to be stored in the repository JIRA: RELENG-133 Change-Id: I7812b2d6a69b9feb37b6c592c978f91b335c0a1c Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'docs/pre-hook.sh')
-rw-r--r--docs/pre-hook.sh11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/pre-hook.sh b/docs/pre-hook.sh
new file mode 100644
index 0000000..4ecdb19
--- /dev/null
+++ b/docs/pre-hook.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+# SPDX-license-identifier: Apache-2.0
+##############################################################################
+# Copyright (c) 2016 NEC and others.
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+sphinx-apidoc -o docs/apidocs yardstick