From 3f631bd5437f78edb23713550f00fa8ebf8b4a44 Mon Sep 17 00:00:00 2001 From: Ivan Kolodyazhny Date: Thu, 21 Nov 2013 15:57:31 +0000 Subject: [PATCH 1/3] Fixed build warnings --- conf.py | 2 +- contents.rst | 4 +-- .../0030-howtos.rst | 31 ++++++++++--------- .../0040-corosync-crashes.rst | 5 +-- .../0070-common-technical-issues.rst | 6 ++-- .../0080-other-questions.rst | 1 + .../0030-pre-installation-checklist.rst | 3 +- pages/pre-install-guide/0090-appendix.rst | 4 +-- .../0020-logical-setup.rst | 2 +- pages/user-guide/custom-attributes.rst | 1 + .../user-guide/post-install-healthchecks.rst | 2 +- 11 files changed, 32 insertions(+), 29 deletions(-) diff --git a/conf.py b/conf.py index ad680d21b..1256e4c01 100644 --- a/conf.py +++ b/conf.py @@ -75,7 +75,7 @@ release = '3.2' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_*', "pages", 'relnotes', 'contents',] +exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'pdf_*'] # exclude_patterns = ['_*', 'rn_index.rst'] # The reST default role (used for this markup: `text`) to use for all documents. diff --git a/contents.rst b/contents.rst index 344cb3789..ef3c7f20a 100644 --- a/contents.rst +++ b/contents.rst @@ -1,10 +1,10 @@ .. index Documentation -.. _Documentation: +.. Documentation_: ============================= -Documentation +_Documentation ============================= .. toctree:: Documentation diff --git a/pages/frequently-asked-questions/0030-howtos.rst b/pages/frequently-asked-questions/0030-howtos.rst index b763bf457..b5d67af14 100644 --- a/pages/frequently-asked-questions/0030-howtos.rst +++ b/pages/frequently-asked-questions/0030-howtos.rst @@ -19,33 +19,34 @@ need to create it yourself, use this procedure: configure. 1. Create the partition itself - :: + :: + + fdisk /dev/sdb + n(for new) + p(for partition) + (to accept the defaults) + (to accept the defaults) + w(to save changes) - fdisk /dev/sdb - n(for new) - p(for partition) - (to accept the defaults) - (to accept the defaults) - w(to save changes) 2. Initialize the XFS partition - :: + :: - mkfs.xfs -i size=1024 -f /dev/sdb1 + mkfs.xfs -i size=1024 -f /dev/sdb1 3. For a standard swift install, all data drives are mounted directly under /srv/node, so first create the mount point - :: + :: - mkdir -p /srv/node/sdb1 + mkdir -p /srv/node/sdb1 4. Finally, add the new partition to fstab so it mounts automatically, then mount all current partitions - :: + :: - echo "/dev/sdb1 /srv/node/sdb1 xfs - noatime,nodiratime,nobarrier,logbufs=8 0 0" >> /etc/fstab - mount -a + echo "/dev/sdb1 /srv/node/sdb1 xfs + noatime,nodiratime,nobarrier,logbufs=8 0 0" >> /etc/fstab + mount -a .. index:: HowTo: Redeploy a node from scratch diff --git a/pages/frequently-asked-questions/0040-corosync-crashes.rst b/pages/frequently-asked-questions/0040-corosync-crashes.rst index 1ad84ae5e..4b6cdc70c 100644 --- a/pages/frequently-asked-questions/0040-corosync-crashes.rst +++ b/pages/frequently-asked-questions/0040-corosync-crashes.rst @@ -11,9 +11,10 @@ through Corosync with MySQL issues. 1. Verify that corosync is really broken ``service corosync status``. -* You should see next error:: +* You should see next error + :: - corosync dead but pid file exists + corosync dead but pid file exists 2. Start corosync manually ``service corosync start``. diff --git a/pages/frequently-asked-questions/0070-common-technical-issues.rst b/pages/frequently-asked-questions/0070-common-technical-issues.rst index 0951a6ce6..563a2aaf5 100644 --- a/pages/frequently-asked-questions/0070-common-technical-issues.rst +++ b/pages/frequently-asked-questions/0070-common-technical-issues.rst @@ -32,13 +32,13 @@ This is a Puppet bug. See: http://projects.puppetlabs.com/issues/4680 * On Puppet client :: - rm -f /etc/puppet/ssl/certificate_requests/\*.pem - rm -f /etc/puppet/ssl/certs/\*.pem + rm -f /etc/puppet/ssl/certificate_requests/\*.pem + rm -f /etc/puppet/ssl/certs/\*.pem * On Puppet master :: - rm -f /var/lib/puppet/ssl/ca/requests/\*.pem + rm -f /var/lib/puppet/ssl/ca/requests/\*.pem **Issue:** The manifests are up-to-date under ``/etc/puppet/manifests``, but Puppet diff --git a/pages/frequently-asked-questions/0080-other-questions.rst b/pages/frequently-asked-questions/0080-other-questions.rst index 4954e0dec..4670b883d 100644 --- a/pages/frequently-asked-questions/0080-other-questions.rst +++ b/pages/frequently-asked-questions/0080-other-questions.rst @@ -6,6 +6,7 @@ Other Questions =============== .. TODO(mihgen): Provide more clear and reflecting reality answer + 1. **[Q]** Why did you decide to provide OpenStack packages through your own repository? diff --git a/pages/pre-install-guide/0030-pre-installation-checklist.rst b/pages/pre-install-guide/0030-pre-installation-checklist.rst index ab40f8181..af07024bf 100644 --- a/pages/pre-install-guide/0030-pre-installation-checklist.rst +++ b/pages/pre-install-guide/0030-pre-installation-checklist.rst @@ -49,8 +49,7 @@ a successful deployment. | the Fuel server from your PC).  | | +--------------------------------------------------------+--------------+ -.. note:: * You need tagged ports in order to use Nova-network VLAN Manager or - Neutron with VLAN segmentation. +.. note:: * You need tagged ports in order to use Nova-network VLAN Manager or Neutron with VLAN segmentation. If you checked all the boxes in the above table, you are ready to deploy Mirantis OpenStack with Fuel. diff --git a/pages/pre-install-guide/0090-appendix.rst b/pages/pre-install-guide/0090-appendix.rst index 1c2fc03c8..e853fce35 100644 --- a/pages/pre-install-guide/0090-appendix.rst +++ b/pages/pre-install-guide/0090-appendix.rst @@ -44,8 +44,8 @@ As a model example, the following configuration is used: From the server node side, ports with the following VLAN IDs for networks are used: -* eth0 - Management VLAN 101 (tagged), Storage VLAN 102(tagged) and - Administrative VLAN 104 (untagged) +* eth0 - Management VLAN 101 (tagged), Storage VLAN 102(tagged) and Administrative VLAN 104 (untagged) + * eth1 - Public/Floating VLAN 100 (tagged), Private VLAN 103 (tagged) diff --git a/pages/reference-architecture/0020-logical-setup.rst b/pages/reference-architecture/0020-logical-setup.rst index 53826c867..b72ef0ce4 100644 --- a/pages/reference-architecture/0020-logical-setup.rst +++ b/pages/reference-architecture/0020-logical-setup.rst @@ -21,7 +21,7 @@ You must keep in mind, however, that the database uses Galera to achieve HA, and Galera is a quorum-based system. That means that you must provide at least 3 controller nodes. -.. image:: /_images/logical-diagram-controller_svg.jpg +.. image:: /_images/logical-diagram-controller.svg :align: center Every OpenStack controller runs HAProxy, which manages a single External diff --git a/pages/user-guide/custom-attributes.rst b/pages/user-guide/custom-attributes.rst index 676be7f72..e3bb7363a 100644 --- a/pages/user-guide/custom-attributes.rst +++ b/pages/user-guide/custom-attributes.rst @@ -58,6 +58,7 @@ structure::: packages/manifests/init.pp **init.pp** should have this content::: + class profile { $tools = $::fuel_settings['tools'] package { $tools : diff --git a/pages/user-guide/post-install-healthchecks.rst b/pages/user-guide/post-install-healthchecks.rst index 2c287d3af..3e96515c9 100644 --- a/pages/user-guide/post-install-healthchecks.rst +++ b/pages/user-guide/post-install-healthchecks.rst @@ -247,7 +247,7 @@ To prepare Murano for testing: 1. Configure key pair 'murano-lb-key' in the 'admin' tenant. 2. Create a Windows image with Murano agent. - See `Murano documentation `_ + See `Murano documentation (Image Builder) `_ 3. Upload the image to the OpenStack Image Service (Glance) into the 'admin' tenant. 4. Rename the image name to 'ws-2012-std'. 5. In the OpenStack Dashboard, click the 'Project' tab. From 9da9226f2ae8bdbe60c519d4106101a1c6aa0ae1 Mon Sep 17 00:00:00 2001 From: Ivan Kolodyazhny Date: Wed, 27 Nov 2013 12:42:03 +0000 Subject: [PATCH 2/3] Fixing build warnings (in progress) --- Makefile | 2 +- conf.py | 3 +- pdf/conf.py | 357 +++++++++++++++++++ pdf_install.rst => pdf/pdf_install.rst | 2 +- pdf_preinstall.rst => pdf/pdf_preinstall.rst | 2 +- pdf_reference.rst => pdf/pdf_reference.rst | 2 +- pdf_user.rst => pdf/pdf_user.rst | 2 +- pdf_pre-install.rst | 31 -- 8 files changed, 364 insertions(+), 37 deletions(-) create mode 100644 pdf/conf.py rename pdf_install.rst => pdf/pdf_install.rst (94%) rename pdf_preinstall.rst => pdf/pdf_preinstall.rst (93%) rename pdf_reference.rst => pdf/pdf_reference.rst (94%) rename pdf_user.rst => pdf/pdf_user.rst (95%) delete mode 100644 pdf_pre-install.rst diff --git a/Makefile b/Makefile index 21e81ef54..a76516d79 100644 --- a/Makefile +++ b/Makefile @@ -122,7 +122,7 @@ latex: images "(use \`make latexpdf' here to do that automatically)." pdf: images - $(SPHINXBUILD) -b pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf + $(SPHINXBUILD) -b pdf -c pdf $(ALLSPHINXOPTS) $(BUILDDIR)/pdf @echo @echo "Build finished; the PDF file is in $(BUILDDIR)/pdf." diff --git a/conf.py b/conf.py index 1256e4c01..52081e107 100644 --- a/conf.py +++ b/conf.py @@ -75,7 +75,8 @@ release = '3.2' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'pdf_*'] +exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'pdf'] +#exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide']#, 'pdf_*'] # exclude_patterns = ['_*', 'rn_index.rst'] # The reST default role (used for this markup: `text`) to use for all documents. diff --git a/pdf/conf.py b/pdf/conf.py new file mode 100644 index 000000000..34d768519 --- /dev/null +++ b/pdf/conf.py @@ -0,0 +1,357 @@ +# -*- coding: utf-8 -*- +# +# "Fuel" documentation build configuration file, created by +# sphinx-quickstart on Tue Sep 25 14:02:29 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os +import cloud_sptheme as csp + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +# 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 +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +#if on_rtd: +# extensions = ['sphinx.ext.autodoc','sphinxcontrib.plantuml'] +# display_github = False +#else: +extensions = ['sphinx.ext.autodoc','rst2pdf.pdfbuilder','sphinxcontrib.plantuml'] +#,'sphinxcontrib.fancybox'] + +plantuml = ['java','-jar','/sbin/plantuml.jar'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +# master_doc = 'contents' + +# General information about the project. +project = u'Fuel for OpenStack' +copyright = u'2013, Mirantis Inc.' + +# 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 = '3.2' + +# The full version, including alpha/beta/rc tags. +release = '3.2' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '*.rst'] +#exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide']#, 'pdf_*'] +# exclude_patterns = ['_*', 'rn_index.rst'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "mirantis" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { "roottarget": "index" } + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = ["_templates", csp.get_theme_dir()] + +html_add_permalinks = None + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = project + ' v' + release + ' | Documentation' +html_title = 'Fuel v' + release + ' for OpenStack | Documentation' + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = '_static/fuel-logo.png' +html_logo = '_static/fuel_gradient_200.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '_static/mirantis_icon.ico' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%c, %Z' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +html_use_smartypants = False + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { + '**': ['searchbox.html', 'globaltoc.html'], +} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +html_use_index = True + +# If true, the index is split into individual pages for each letter. +html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +html_show_sphinx = False + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'fueldoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('install', 'install.tex', u'Fuel Installation Guide | Documentation', + u'Mirantis Inc.', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'fuel', u'Fuel for OpenStack | Documentation', + [u'Mirantis'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'fuel', u'Fuel for OpenStack | Documentation', + u'Mirantis Inc.', 'fuel', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' +# -- Additional Settings ------------------------------------------------------- + + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +# extensions += ['sphinx.ext.inheritance_diagram', 'sphinxcontrib.blockdiag', 'sphinxcontrib.actdiag', 'sphinxcontrib.seqdiag', 'sphinxcontrib.nwdiag'] + +# The encoding of source files. +source_encoding = 'utf-8' +#source_encoding = 'shift_jis' + +# The language for content autogenerated by Sphinx. +#language = 'en' +#language = 'ja' + +# Enable Antialiasing +blockdiag_antialias = True +acttdiag_antialias = True +seqdiag_antialias = True +nwdiag_antialias = True + +extensions += ['rst2pdf.pdfbuilder'] +pdf_documents = [ + ('pdf/pdf_user', u'Fuel-for-OpenStack-3.2-UserGuide', u'User Guide', + u'2013, Mirantis Inc.'), + ('pdf/pdf_install', u'Fuel-for-OpenStack-3.2-InstallGuide', u'Installation Guide', u'2013, Mirantis Inc.'), + ('pdf/pdf_reference', u'Fuel-for-OpenStack-3.2-ReferenceArchitecture', u'Reference Architecture', u'2013, Mirantis Inc.'), + ('pdf/pdf_preinstall', u'Fuel-for-OpenStack-3.2-Pre-InstallationGuide', u'Pre-Installation Guide', u'2013, Mirantis Inc.') +# (master_doc, project, project, copyright), +] +pdf_stylesheets = ['letter', 'mirantis'] +pdf_style_path = ['_templates'] +#pdf_language = "en" +# Mode for literal blocks wider than the frame. Can be +# overflow, shrink or truncate +pdf_fit_mode = "shrink" + +# Section level that forces a break page. +# For example: 1 means top-level sections start in a new page +# 0 means disabled +pdf_break_level = 1 + +# When a section starts in a new page, force it to be 'even', 'odd', +# or just use 'any' +pdf_breakside = 'any' + +# Insert footnotes where they are defined instead of +# at the end. +#pdf_inline_footnotes = True + +# verbosity level. 0 1 or 2 +pdf_verbosity = 0 + +# If false, no index is generated. +#pdf_use_index = True + +# If false, no modindex is generated. +#pdf_use_modindex = False + +# If false, no coverpage is generated. +# pdf_use_coverpage = False + +# Name of the cover page template to use +pdf_cover_template = 'mirantiscover.tmpl' + +# Documents to append as an appendix to all manuals. +#pdf_appendices = [] + +# Enable experimental feature to split table cells. Use it +# if you get "DelayedTable too big" errors +#pdf_splittables = False + +# Set the default DPI for images +#pdf_default_dpi = 72 + +# Enable rst2pdf extension modules (default is only vectorpdf) +# you need vectorpdf if you want to use sphinx's graphviz support +#pdf_extensions = ['vectorpdf'] + +# Page template name for "regular" pages +# pdf_page_template = 'cutePage' +pdf_page_template = 'oneColumn' + +# Show Table Of Contents at the beginning? +pdf_use_toc = True + +# How many levels deep should the table of contents be? +pdf_toc_depth = 2 + +# Add section number to section references +#pdf_use_numbered_links = False + +# Background images fitting mode +pdf_fit_background_mode = 'scale' + +pdf_font_path = ['C:\\Windows\\Fonts\\', '/usr/share/fonts', '_fonts'] diff --git a/pdf_install.rst b/pdf/pdf_install.rst similarity index 94% rename from pdf_install.rst rename to pdf/pdf_install.rst index 7b5e304a0..ef31ad318 100644 --- a/pdf_install.rst +++ b/pdf/pdf_install.rst @@ -25,7 +25,7 @@ .. toctree:: Table of Contents :maxdepth: 2 -.. include:: contents/contents-install.rst +.. include:: ../contents/contents-install.rst diff --git a/pdf_preinstall.rst b/pdf/pdf_preinstall.rst similarity index 93% rename from pdf_preinstall.rst rename to pdf/pdf_preinstall.rst index ae863c8c8..dd46803e4 100644 --- a/pdf_preinstall.rst +++ b/pdf/pdf_preinstall.rst @@ -25,7 +25,7 @@ .. toctree:: Table of Contents :maxdepth: 2 -.. include:: contents/contents-pre-install-guide.rst +.. include:: ../contents/contents-pre-install-guide.rst diff --git a/pdf_reference.rst b/pdf/pdf_reference.rst similarity index 94% rename from pdf_reference.rst rename to pdf/pdf_reference.rst index bbd54ab41..46d3e340b 100644 --- a/pdf_reference.rst +++ b/pdf/pdf_reference.rst @@ -25,4 +25,4 @@ .. toctree:: Table of Contents :maxdepth: 2 -.. include:: contents/contents-refarch.rst +.. include:: ../contents/contents-refarch.rst diff --git a/pdf_user.rst b/pdf/pdf_user.rst similarity index 95% rename from pdf_user.rst rename to pdf/pdf_user.rst index 4d5f7ae0f..62ce1749e 100644 --- a/pdf_user.rst +++ b/pdf/pdf_user.rst @@ -25,4 +25,4 @@ .. toctree:: Table of Contents :maxdepth: 2 -.. include:: contents/contents-user.rst +.. include:: ../contents/contents-user.rst diff --git a/pdf_pre-install.rst b/pdf_pre-install.rst deleted file mode 100644 index ae863c8c8..000000000 --- a/pdf_pre-install.rst +++ /dev/null @@ -1,31 +0,0 @@ - -.. header:: - - .. cssclass:: header-table - - +-------------------------------------+-----------------------------------+ - | Fuel for OpenStack v3.2 | .. cssclass:: right| - | | | - | Pre-Installation Guide | ###Section### | - +-------------------------------------+-----------------------------------+ - -.. footer:: - - .. cssclass:: footer-table - - +--------------------------+----------------------+ - | | .. cssclass:: right| - | | | - | ©2013, Mirantis Inc. | Page ###Page### | - +--------------------------+----------------------+ - -.. raw:: pdf - - PageBreak oneColumn - -.. toctree:: Table of Contents - :maxdepth: 2 -.. include:: contents/contents-pre-install-guide.rst - - - From d0dcf12f4dec11778f0924f1cb5d827ceb4a72e6 Mon Sep 17 00:00:00 2001 From: Ivan Kolodyazhny Date: Wed, 27 Nov 2013 19:40:21 +0000 Subject: [PATCH 3/3] 'make html' command doesn't show any warnings now --- Makefile | 2 +- conf.py | 1 - contents.rst | 8 +++++--- index.rst | 2 ++ pages/pre-install-guide/0060-quick-install-fuel.rst | 6 ++++++ pages/release-notes/v3-2-grizzly-full.rst | 2 ++ pages/user-guide/0070-introduction.rst | 2 +- pdf/conf.py | 1 - relnotes/conf.py | 2 +- 9 files changed, 18 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index a76516d79..69f149cb0 100644 --- a/Makefile +++ b/Makefile @@ -61,7 +61,7 @@ images: $(JPGs) all: clean html dirhtml singlehtml latexpdf pdf html: images - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + $(SPHINXBUILD) -b html -W $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/conf.py b/conf.py index 52081e107..3cb32e561 100644 --- a/conf.py +++ b/conf.py @@ -76,7 +76,6 @@ release = '3.2' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'pdf'] -#exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide']#, 'pdf_*'] # exclude_patterns = ['_*', 'rn_index.rst'] # The reST default role (used for this markup: `text`) to use for all documents. diff --git a/contents.rst b/contents.rst index ef3c7f20a..87ad8280c 100644 --- a/contents.rst +++ b/contents.rst @@ -1,13 +1,15 @@ +:orphan: + .. index Documentation -.. Documentation_: +.. Documentation: ============================= -_Documentation +Documentation ============================= -.. toctree:: Documentation +.. toctree:: :maxdepth: 2 pre-install-guide diff --git a/index.rst b/index.rst index 937b625a4..7129bbc49 100644 --- a/index.rst +++ b/index.rst @@ -1,3 +1,5 @@ +:orphan: + .. index:: Home page .. _Homepage: diff --git a/pages/pre-install-guide/0060-quick-install-fuel.rst b/pages/pre-install-guide/0060-quick-install-fuel.rst index 5676c3ec7..abfd7fdec 100644 --- a/pages/pre-install-guide/0060-quick-install-fuel.rst +++ b/pages/pre-install-guide/0060-quick-install-fuel.rst @@ -35,11 +35,17 @@ To install Fuel using the ISO image: 10. Verify the network configuration by clicking **Verify Networks**. 11. In the **Settings** tab, modify additional options: + * Access + * OpenStack Components + * Hypervisor type + * Storage + * Scheduler driver + * Syslog 12. Assign a role for each node server. diff --git a/pages/release-notes/v3-2-grizzly-full.rst b/pages/release-notes/v3-2-grizzly-full.rst index c52229f1d..04128d639 100644 --- a/pages/release-notes/v3-2-grizzly-full.rst +++ b/pages/release-notes/v3-2-grizzly-full.rst @@ -1,3 +1,5 @@ +:orphan: + .. index:: Release Notes: Fuel 3.2 .. _RelNotes_3.2: diff --git a/pages/user-guide/0070-introduction.rst b/pages/user-guide/0070-introduction.rst index f591daf5e..2468d39e1 100644 --- a/pages/user-guide/0070-introduction.rst +++ b/pages/user-guide/0070-introduction.rst @@ -1,6 +1,6 @@ .. index:: Introduction -.. _Introduction: +.. _User_Introduction: Introducing Fuel for OpenStack =============================== diff --git a/pdf/conf.py b/pdf/conf.py index 34d768519..a106f670e 100644 --- a/pdf/conf.py +++ b/pdf/conf.py @@ -76,7 +76,6 @@ release = '3.2' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide', '*.rst'] -#exclude_patterns = ['_*', "pages", 'relnotes', 'contents', 'index', '*-guide']#, 'pdf_*'] # exclude_patterns = ['_*', 'rn_index.rst'] # The reST default role (used for this markup: `text`) to use for all documents. diff --git a/relnotes/conf.py b/relnotes/conf.py index 97827358f..6473e44ad 100644 --- a/relnotes/conf.py +++ b/relnotes/conf.py @@ -75,7 +75,7 @@ release = '3.2' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_*', "pages"] +exclude_patterns = ['_*', "pages", 'pdf', 'contents', 'index', '*-guide'] # exclude_patterns = ['_*', 'rn_index.rst'] # The reST default role (used for this markup: `text`) to use for all documents.