diff options
| author |   Ryota MIBU <r-mibu@cq.jp.nec.com> | 2016-07-20 19:30:05 +0900 |
|---|---|---|
| committer | Ryota Mibu <r-mibu@cq.jp.nec.com> | 2016-07-22 11:50:47 +0000 |
| commit | a3174cb38b1dc22802da837d1bd0c3e117b9f43a (patch) | |
| tree | 78073ef4812f3e3a4add81beecb29cf1d6dfe441 /etc/conf.py | |
| parent | 2b890ae86bc8dcc16cc7e1f0cb00357c7892486b (diff) | |
improve config
A developer was asked to copy all contents in the base config file in
order to set all parameters properly, even if the change is partial.
This patch improves this config by setting all default parameters based
on users' custom config file, so that they can write parameters just
which they want to change.
Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'etc/conf.py')
| -rw-r--r-- | etc/conf.py | 40 |
1 files changed, 0 insertions, 40 deletions
diff --git a/etc/conf.py b/etc/conf.py deleted file mode 100644 index c4cbae775..000000000 --- a/etc/conf.py +++ /dev/null @@ -1,40 +0,0 @@ -# SPDX-license-identifier: Apache-2.0 -############################################################################## -# Copyright (c) 2016 Linux Foundation 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 -############################################################################## -''' -Base configuration file for building OPNFV docs - -You can override this configuration by putting 'conf.py' in the document -directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py' -in the document directory, this file will be copied to that directory -before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge'). - -You may need python package installation for new sphinx extension. -Install python package with 'pip' in your machine and add the extension to -the 'extensions' list below to test the documentation build locally. -If you feel that your extensions would be useful for other projects too, -we encourage you to propose a change in the releng repository. - -For further guidance see the https://wiki.opnfv.org/documentation/tools page. -''' - -extensions = ['sphinxcontrib.httpdomain', - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon'] - -needs_sphinx = '1.3' -master_doc = 'index' -pygments_style = 'sphinx' - -html_use_index = False -numfig = True -html_logo = 'opnfv-logo.png' - -latex_domain_indices = False -latex_logo = 'opnfv-logo.png' |