diff options
Diffstat (limited to 'etc')
| -rw-r--r-- | etc/conf.py | 40 | ||||
| -rw-r--r-- | etc/opnfv-logo.png | bin | 0 -> 2829 bytes | |||
| -rw-r--r-- | etc/requirements.txt | 6 |
3 files changed, 46 insertions, 0 deletions
diff --git a/etc/conf.py b/etc/conf.py new file mode 100644 index 000000000..c4cbae775 --- /dev/null +++ b/etc/conf.py @@ -0,0 +1,40 @@ +# 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' diff --git a/etc/opnfv-logo.png b/etc/opnfv-logo.png Binary files differnew file mode 100644 index 000000000..1519503eb --- /dev/null +++ b/etc/opnfv-logo.png diff --git a/etc/requirements.txt b/etc/requirements.txt new file mode 100644 index 000000000..4b1850729 --- /dev/null +++ b/etc/requirements.txt @@ -0,0 +1,6 @@ +Sphinx==1.3.1 +doc8 +docutils +setuptools +six +sphinxcontrib-httpdomain |
