Code Review
/
doc.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Updated git submodules
[doc.git]
/
docs
/
conf.py
diff --git
a/docs/conf.py
b/docs/conf.py
index
cbf90f7
..
393e2ac
100644
(file)
--- a/
docs/conf.py
+++ b/
docs/conf.py
@@
-15,6
+15,7
@@
import sys
import os
import shlex
import sys
import os
import shlex
+#import sphinx_bootstrap_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@
-37,9
+38,16
@@
extensions = [
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag',
'sphinx.ext.imgmath',
'sphinx.ext.viewcode',
'sphinxcontrib.blockdiag',
- 'sphinxcontrib.seqdiag'
+ 'sphinxcontrib.seqdiag',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.todo',
+ 'sphinxcontrib.plantuml',
+ 'sphinxcontrib.swaggerdoc'
]
]
+# Font path for seqdiag
+seqdiag_fontpath= '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf'
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@
-55,18
+63,20
@@
source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
master_doc = 'index'
# General information about the project.
-project = u'ONAP'
-copyright = u'2017, ONAP Contributors'
-author = u'ONAP Contributors'
+project = u''
+copyright = u'2017 ONAP. Licensed under Creative Commons Attribution 4.0 International License'
+
+
+author = u'Open Network Automation Platform'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '
pre-release alpha
'
+version = '
Latest
'
# The full version, including alpha/beta/rc tags.
# The full version, including alpha/beta/rc tags.
-release = '
Amsterdam 0.1 alpha
'
+release = '
Latest
'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@
-84,8
+94,7
@@
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = [
- '_build',
- 'submodules/vnfrqts'
+ '_build'
]
# The reST default role (used for this markup: `text`) to use for all
]
# The reST default role (used for this markup: `text`) to use for all
@@
-120,6
+129,7
@@
todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
+#html_theme = 'bootstrap'
html_theme = 'classic'
# Theme options are theme-specific and customize the look and feel of a theme
html_theme = 'classic'
# Theme options are theme-specific and customize the look and feel of a theme
@@
-128,7
+138,7
@@
html_theme = 'classic'
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path =
[]
+#html_theme_path =
sphinx_bootstrap_theme.get_html_theme_path()
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
@@
-158,7
+168,7
@@
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-
#html_last_updated_fmt = '%b %d, %Y
'
+
html_last_updated_fmt = '%d-%b-%y %H:%M
'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
@@
-184,7
+194,7
@@
html_static_path = ['_static']
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-
#html_show_sphinx = Tru
e
+
html_show_sphinx = Fals
e
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
@@
-364,3
+374,7
@@
epub_exclude_files = ['search.html']
# If false, no index is generated.
#epub_use_index = True
# If false, no index is generated.
#epub_use_index = True
+
+# Patterns to ignore in linkcheck builder
+linkcheck_ignore = [r'http://localhost:\d+/']
+