From 7fdc0e25697fb43e8a044c4fa86167439be43999 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 27 Jun 2017 15:10:41 +0200 Subject: [PATCH] Build separate glossary Build glossary as separate document. Change-Id: I2592d68d6770d66ceaab87a774522ab1671b2296 --- doc-tools-check-languages.conf | 1 + doc/glossary/setup.cfg | 27 +++ doc/glossary/setup.py | 30 ++++ doc/glossary/source/common | 1 + doc/glossary/source/conf.py | 305 +++++++++++++++++++++++++++++++++ doc/glossary/source/index.rst | 16 ++ tools/build-all-rst.sh | 2 +- 7 files changed, 381 insertions(+), 1 deletion(-) create mode 100644 doc/glossary/setup.cfg create mode 100644 doc/glossary/setup.py create mode 120000 doc/glossary/source/common create mode 100644 doc/glossary/source/conf.py create mode 100644 doc/glossary/source/index.rst diff --git a/doc-tools-check-languages.conf b/doc-tools-check-languages.conf index 26eaeed3c9..d4dd03b3c8 100644 --- a/doc-tools-check-languages.conf +++ b/doc-tools-check-languages.conf @@ -24,6 +24,7 @@ DOC_DIR="doc/" declare -A SPECIAL_BOOKS=( # This needs special handling, handle it with the RST tools. ["common"]="RST" + ["glossary"]="RST" ["ha-guide"]="RST" ["image-guide"]="RST" ["install-guide"]="RST" diff --git a/doc/glossary/setup.cfg b/doc/glossary/setup.cfg new file mode 100644 index 0000000000..6c31b47e24 --- /dev/null +++ b/doc/glossary/setup.cfg @@ -0,0 +1,27 @@ +[metadata] +name = openstackdocumentationglossary +summary = OpenStack Documentation Glossary +author = OpenStack +author-email = openstack-docs@lists.openstack.org +home-page = https://docs.openstack.org/ +classifier = +Environment :: OpenStack +Intended Audience :: Information Technology +Intended Audience :: Documentation Contributors +License :: OSI Approved :: Apache Software License +Operating System :: POSIX :: Linux +Topic :: Documentation + +[global] +setup-hooks = + pbr.hooks.setup_hook + +[files] + +[build_sphinx] +warning-is-error = 1 +build-dir = build +source-dir = source + +[wheel] +universal = 1 diff --git a/doc/glossary/setup.py b/doc/glossary/setup.py new file mode 100644 index 0000000000..736375744d --- /dev/null +++ b/doc/glossary/setup.py @@ -0,0 +1,30 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +# In python < 2.7.4, a lazy loading of package `pbr` will break +# setuptools if some other modules registered functions in `atexit`. +# solution from: http://bugs.python.org/issue15881#msg170215 +try: + import multiprocessing # noqa +except ImportError: + pass + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/doc/glossary/source/common b/doc/glossary/source/common new file mode 120000 index 0000000000..dc879abe93 --- /dev/null +++ b/doc/glossary/source/common @@ -0,0 +1 @@ +../../common \ No newline at end of file diff --git a/doc/glossary/source/conf.py b/doc/glossary/source/conf.py new file mode 100644 index 0000000000..1d203d0b77 --- /dev/null +++ b/doc/glossary/source/conf.py @@ -0,0 +1,305 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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 os +# import sys + + +# 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. +extensions = ['openstackdocstheme'] + + +# 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 = 'index' + +# General information about the project. +repository_name = 'openstack/openstack-manuals' +project = u'Glossary' +bug_tag = u'glossary' + +copyright = u'2015-2017, OpenStack contributors' + + +# 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 = '15.0' +# The full version, including alpha/beta/rc tags. +release = '15.0.0' + +# 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 = ['common/app-support.rst', 'common/cli*', 'common/nova*', + 'common/appendix.rst', + 'common/get-started*', 'common/dashboard*', + 'common/conventions.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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- 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 = 'openstackdocs' + +# 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 = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [openstackdocstheme.get_html_theme_path()] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# 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 = None + +# 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 = None + +# 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 = [] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# So that we can enable "log-a-bug" links from each output HTML page, this +# variable must be set to a format that includes year, month, day, hours and +# minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# 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 = False + +# 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. +# This one is needed for "Report a bug". +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# 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 = 'contributor-guide' + +# If true, publish source files +html_copy_source = False + +# -- Options for LaTeX output --------------------------------------------- + +latex_engine = 'xelatex' + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # set font (TODO: different fonts for translated PDF document builds) + 'fontenc': '\\usepackage{fontspec}', + 'fontpkg': '''\ +\defaultfontfeatures{Scale=MatchLowercase} +\setmainfont{Liberation Serif} +\setsansfont{Liberation Sans} +\setmonofont[SmallCapsFont={Liberation Mono}]{Liberation Mono} +''', + + # 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, or own class]). +latex_documents = [ + ('index', 'ContributorGuide.tex', u'Contributor Guide', + u'OpenStack contributors', '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', 'contributorguide', u'Contributor Guide', + [u'OpenStack contributors'], 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', 'UserGuide', u'User Guide', + u'OpenStack contributors', 'UserGuide', + 'This manual explains the principles of the contributing to the ' + 'OpenStack documentation', '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' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] + +# -- Options for PDF output -------------------------------------------------- + +pdf_documents = [ + ('index', u'ContributorGuide', u'Contributor Guide', u'OpenStack ' + 'contributors'), +] diff --git a/doc/glossary/source/index.rst b/doc/glossary/source/index.rst new file mode 100644 index 0000000000..41f48a2af9 --- /dev/null +++ b/doc/glossary/source/index.rst @@ -0,0 +1,16 @@ +================== +OpenStack Glossary +================== + +Abstract +~~~~~~~~ + +This document is a glossary of terms relevant to OpenStack. + +Contents +~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + common/glossary.rst diff --git a/tools/build-all-rst.sh b/tools/build-all-rst.sh index 39e8931789..6bf47c90a1 100755 --- a/tools/build-all-rst.sh +++ b/tools/build-all-rst.sh @@ -32,7 +32,7 @@ PDF_TARGETS=( 'arch-design'\ 'image-guide' \ 'install-guide') -for guide in arch-design contributor-guide \ +for guide in arch-design contributor-guide glossary \ ha-guide ha-guide-draft image-guide install-guide; do if [[ ${PDF_TARGETS[*]} =~ $guide ]]; then tools/build-rst.sh doc/$guide --build build \