From 7bd5e5cf241af264fee181adc50ed3a110db13a6 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Mon, 25 Jul 2016 11:37:16 +0900 Subject: [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 --- .gitignore | 2 +- docs/pre-hook.sh | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 docs/pre-hook.sh diff --git a/.gitignore b/.gitignore index 6f462f55a..4843ba8ba 100644 --- a/.gitignore +++ b/.gitignore @@ -28,4 +28,4 @@ cover/ .*.sw? /docs_build/ /docs_output/ -/releng/ +/docs/apidocs/yardstick*.rst diff --git a/docs/pre-hook.sh b/docs/pre-hook.sh new file mode 100644 index 000000000..4ecdb198e --- /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 -- cgit 1.2.3-korg