Wrong characters fixed. Sphinx configuration simplified
Change-Id: I80f198186b7f6e9b23959050c2c12fb1400077e0
This commit is contained in:
Illia Polliul
parent
96be2ba5f9
commit
29d061859d
|
|
@ -5,7 +5,7 @@
|
|||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = _build
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
|
|
@ -15,9 +15,14 @@ endif
|
|||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# SVG to PDF conversion
|
||||
SVG2PDF = inkscape
|
||||
SVG2PDF_FLAGS =
|
||||
# Build a list of SVG files to convert to PDF
|
||||
PDF_FILES := $(foreach dir, images, $(patsubst %.svg,%.pdf,$(wildcard $(dir)/*.svg)))
|
||||
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
|
||||
|
||||
|
|
@ -1,76 +1,23 @@
|
|||
# BSD LICENSE
|
||||
# Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
|
||||
# All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without
|
||||
# modification, are permitted provided that the following conditions
|
||||
# are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright
|
||||
# notice, this list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright
|
||||
# notice, this list of conditions and the following disclaimer in
|
||||
# the documentation and/or other materials provided with the
|
||||
# distribution.
|
||||
# * Neither the name of Intel Corporation nor the names of its
|
||||
# contributors may be used to endorse or promote products derived
|
||||
# from this software without specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
import subprocess
|
||||
from docutils import nodes
|
||||
from distutils.version import LooseVersion
|
||||
from sphinx import __version__ as sphinx_version
|
||||
from sphinx.highlighting import PygmentsBridge
|
||||
from pygments.formatters.latex import LatexFormatter
|
||||
|
||||
project = 'Contrail plugin for Fuel'
|
||||
|
||||
if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
#html_logo = '../logo/DPDK_logo_vertical_rev_small.png'
|
||||
#latex_logo = '../logo/DPDK_logo_horizontal_tag.png'
|
||||
html_add_permalinks = ""
|
||||
html_show_copyright = False
|
||||
highlight_language = 'none'
|
||||
|
||||
#version = subprocess.check_output(['make', '-sRrC', '../../', 'showversion']).decode('utf-8')
|
||||
version = 3.0
|
||||
release = version
|
||||
|
||||
source_suffix = '.rst'
|
||||
master_doc = 'index'
|
||||
|
||||
# Figures, tables and code-blocks automatically numbered if they have caption
|
||||
numfig = True
|
||||
project = u'Contrail plugin for Fuel'
|
||||
copyright = u'2015, Mirantis Inc.'
|
||||
|
||||
version = '3.0'
|
||||
release = '3.0.0'
|
||||
|
||||
pygments_style = 'sphinx'
|
||||
|
||||
latex_documents = [
|
||||
('index',
|
||||
'fuel-plugin-contrail-doc.tex',
|
||||
'',
|
||||
'',
|
||||
'manual')
|
||||
('index','fuel-plugin-contrail-doc.tex',
|
||||
u'Contrail plugin for Fuel Documentation',
|
||||
u'Mirantis Inc.', 'manual')
|
||||
]
|
||||
|
||||
# Latex directives to be included directly in the latex/pdf docs.
|
||||
latex_preamble = r"""
|
||||
\usepackage[utf8]{inputenc}
|
||||
\usepackage[T1]{fontenc}
|
||||
\usepackage{helvet}
|
||||
\renewcommand{\familydefault}{\sfdefault}
|
||||
\RecustomVerbatimEnvironment{Verbatim}{Verbatim}{xleftmargin=5mm}
|
||||
"""
|
||||
|
||||
# Configuration for the latex/pdf docs.
|
||||
latex_elements = {
|
||||
'papersize': 'a4paper',
|
||||
|
|
@ -78,80 +25,11 @@ latex_elements = {
|
|||
# remove blank pages
|
||||
'classoptions': ',openany,oneside',
|
||||
'babel': '\\usepackage[english]{babel}',
|
||||
# customize Latex formatting
|
||||
'preamble': latex_preamble
|
||||
}
|
||||
|
||||
# Override the default Latex formatter in order to modify the
|
||||
# code/verbatim blocks.
|
||||
class CustomLatexFormatter(LatexFormatter):
|
||||
def __init__(self, **options):
|
||||
super(CustomLatexFormatter, self).__init__(**options)
|
||||
# Use the second smallest font size for code/verbatim blocks.
|
||||
self.verboptions = r'formatcom=\footnotesize'
|
||||
if LooseVersion(sphinx_version) >= LooseVersion('1.3.1'):
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
|
||||
# Replace the default latex formatter.
|
||||
PygmentsBridge.latex_formatter = CustomLatexFormatter
|
||||
|
||||
######## :numref: fallback ########
|
||||
# The following hook functions add some simple handling for the :numref:
|
||||
# directive for Sphinx versions prior to 1.3.1. The functions replace the
|
||||
# :numref: reference with a link to the target (for all Sphinx doc types).
|
||||
# It doesn't try to label figures/tables.
|
||||
|
||||
def numref_role(reftype, rawtext, text, lineno, inliner):
|
||||
"""
|
||||
Add a Sphinx role to handle numref references. Note, we can't convert
|
||||
the link here because the doctree isn't build and the target information
|
||||
isn't available.
|
||||
"""
|
||||
# Add an identifier to distinguish numref from other references.
|
||||
newnode = nodes.reference('',
|
||||
'',
|
||||
refuri='_local_numref_#%s' % text,
|
||||
internal=True)
|
||||
return [newnode], []
|
||||
|
||||
def process_numref(app, doctree, from_docname):
|
||||
"""
|
||||
Process the numref nodes once the doctree has been built and prior to
|
||||
writing the files. The processing involves replacing the numref with a
|
||||
link plus text to indicate if it is a Figure or Table link.
|
||||
"""
|
||||
|
||||
# Iterate over the reference nodes in the doctree.
|
||||
for node in doctree.traverse(nodes.reference):
|
||||
target = node.get('refuri', '')
|
||||
|
||||
# Look for numref nodes.
|
||||
if target.startswith('_local_numref_#'):
|
||||
target = target.replace('_local_numref_#', '')
|
||||
|
||||
# Get the target label and link information from the Sphinx env.
|
||||
data = app.builder.env.domains['std'].data
|
||||
docname, label, _ = data['labels'].get(target, ('', '', ''))
|
||||
relative_url = app.builder.get_relative_uri(from_docname, docname)
|
||||
|
||||
# Add a text label to the link.
|
||||
if target.startswith('figure'):
|
||||
caption = 'Figure'
|
||||
elif target.startswith('table'):
|
||||
caption = 'Table'
|
||||
else:
|
||||
caption = 'Link'
|
||||
|
||||
# New reference node with the updated link information.
|
||||
newnode = nodes.reference('',
|
||||
caption,
|
||||
refuri='%s#%s' % (relative_url, label),
|
||||
internal=True)
|
||||
node.replace_self(newnode)
|
||||
|
||||
def setup(app):
|
||||
if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
|
||||
print('Upgrade sphinx to version >= 1.3.1 for '
|
||||
'improved Figure/Table number handling.')
|
||||
# Add a role to handle :numref: references.
|
||||
app.add_role('numref', numref_role)
|
||||
# Process the numref references once the doctree has been created.
|
||||
app.connect('doctree-resolved', process_numref)
|
||||
html_add_permalinks = ""
|
||||
html_show_copyright = False
|
||||
highlight_language = 'none'
|
||||
|
|
|
|||
|
|
@ -17,13 +17,13 @@ Log into Contrail UI using the `OpenStack admin credentials.
|
|||
Checking services status
|
||||
------------------------
|
||||
|
||||
Verify the status of Contrail Control Analytics and Config nodes along with vRouters in *Infrastructure* using *Dashboard*
|
||||
Verify the status of Contrail Control Analytics and Config nodes along with vRouters in *Infrastructure* using *Dashboard*
|
||||
tab of the left-hand *Monitor* menu.
|
||||
|
||||
.. image:: images/contrail-services.png
|
||||
|
||||
|
||||
Сreating the virtual networks
|
||||
Creating the virtual networks
|
||||
-----------------------------
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue