openstack/operations-guide
Code Issues Proposed changes

[ops-guide] Set up initial RST structure

Browse Source 
Change-Id: Ife2178f4f17d08f5797310990bb22662819ed106
Implements: blueprint ops-guide-rst
This commit is contained in:
KATO Tomoyuki 2016-01-29 13:11:49 +09:00
parent ae79733807
commit 7b824ddc5c
15 changed files with 4745 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -7,12 +7,13 @@
*.egg-info
# Testenvironment
.tox
.tox/
# Build directories
target/
publish-docs/
generated/
build/
/build-*.log.gz
# Transifex Client Setting

8
doc-tools-check-languages.conf
View File

@ -16,3 +16,11 @@ POM_FILE=""
# Location of doc dir
DOC_DIR="doc/"
# Books with special handling
# Values need to match content in project-config/jenkins/scripts/common_translation_update.sh
declare -A SPECIAL_BOOKS=(
["ops-guide"]="skip"
# These are translated in openstack-manuals
["common-rst"]="skip"
)

7
doc/common/README.txt Normal file
View File

@ -0,0 +1,7 @@
Important note about this directory
===================================
Because this directory is synced from openstack-manuals, make any changes in
openstack-manuals/doc/common. After changes to the synced files merge to
openstack-manuals/doc/common, a patch is automatically proposed for this
directory.

266
doc/common/app_support.rst Normal file
View File

@ -0,0 +1,266 @@
.. ## WARNING ##########################################################
.. This file is synced from openstack/openstack-manuals repository to
.. other related repositories. If you need to make changes to this file,
.. make the changes in openstack-manuals. After any change merged to,
.. openstack-manuals, automatically a patch for others will be proposed.
.. #####################################################################
=================
Community support
=================
The following resources are available to help you run and use OpenStack.
The OpenStack community constantly improves and adds to the main
features of OpenStack, but if you have any questions, do not hesitate to
ask. Use the following resources to get OpenStack support, and
troubleshoot your installations.
Documentation
~~~~~~~~~~~~~
For the available OpenStack documentation, see
`docs.openstack.org <http://docs.openstack.org>`__.
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.
The following books explain how to install an OpenStack cloud and its
associated components:
* `Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise
Server 12
<http://docs.openstack.org/liberty/install-guide-obs/>`__
* `Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7
<http://docs.openstack.org/liberty/install-guide-rdo/>`__
* `Installation Guide for Ubuntu
14.04 <http://docs.openstack.org/liberty/install-guide-ubuntu/>`__
The following books explain how to configure and run an OpenStack cloud:
* `Architecture Design
Guide <http://docs.openstack.org/arch-design/>`__
* `Cloud Administrator
Guide <http://docs.openstack.org/admin-guide-cloud/>`__
* `Configuration
Reference <http://docs.openstack.org/liberty/config-reference/content/>`__
* `Operations Guide <http://docs.openstack.org/ops/>`__
* `Networking Guide <http://docs.openstack.org/liberty/networking-guide>`__
* `High Availability
Guide <http://docs.openstack.org/ha-guide/>`__
* `Security Guide <http://docs.openstack.org/sec/>`__
* `Virtual Machine Image
Guide <http://docs.openstack.org/image-guide/>`__
The following books explain how to use the OpenStack dashboard and
command-line clients:
* `API Guide <http://developer.openstack.org/api-guide/quick-start/>`__
* `End User Guide <http://docs.openstack.org/user-guide/>`__
* `Admin User
Guide <http://docs.openstack.org/user-guide-admin/>`__
* `Command-Line Interface
Reference <http://docs.openstack.org/cli-reference/>`__
The following documentation provides reference and guidance information
for the OpenStack APIs:
* `OpenStack API Complete Reference
(HTML) <http://developer.openstack.org/api-ref.html>`__
* `API Complete Reference
(PDF) <http://developer.openstack.org/api-ref-guides/bk-api-ref.pdf>`__
The following guide provides how to contribute to OpenStack documentation:
* `Documentation contributor guide <http://docs.openstack.org/contributor-guide/>`__
ask.openstack.org
~~~~~~~~~~~~~~~~~
During the set up or testing of OpenStack, you might have questions
about how a specific task is completed or be in a situation where a
feature does not work correctly. Use the
`ask.openstack.org <https://ask.openstack.org>`__ site to ask questions
and get answers. When you visit the https://ask.openstack.org site, scan
the recently asked questions to see whether your question has already
been answered. If not, ask a new question. Be sure to give a clear,
concise summary in the title and provide as much detail as possible in
the description. Paste in your command output or stack traces, links to
screen shots, and any other information which might be useful.
OpenStack mailing lists
~~~~~~~~~~~~~~~~~~~~~~~
A great way to get answers and insights is to post your question or
problematic scenario to the OpenStack mailing list. You can learn from
and help others who might have similar issues. To subscribe or view the
archives, go to
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack. You might
be interested in the other mailing lists for specific projects or
development, which you can find `on the
wiki <https://wiki.openstack.org/wiki/MailingLists>`__. A description of all
mailing lists is available at https://wiki.openstack.org/wiki/MailingLists.
The OpenStack wiki
~~~~~~~~~~~~~~~~~~
The `OpenStack wiki <https://wiki.openstack.org/>`__ contains a broad
range of topics but some of the information can be difficult to find or
is a few pages deep. Fortunately, the wiki search feature enables you to
search by title or content. If you search for specific information, such
as about networking or OpenStack Compute, you can find a large amount
of relevant material. More is being added all the time, so be sure to
check back often. You can find the search box in the upper-right corner
of any OpenStack wiki page.
The Launchpad Bugs area
~~~~~~~~~~~~~~~~~~~~~~~
The OpenStack community values your set up and testing efforts and wants
your feedback. To log a bug, you must sign up for a Launchpad account at
https://launchpad.net/+login. You can view existing bugs and report bugs
in the Launchpad Bugs area. Use the search feature to determine whether
the bug has already been reported or already been fixed. If it still
seems like your bug is unreported, fill out a bug report.
Some tips:
* Give a clear, concise summary.
* Provide as much detail as possible in the description. Paste in your
command output or stack traces, links to screen shots, and any other
information which might be useful.
* Be sure to include the software and package versions that you are
using, especially if you are using a development branch, such as,
``"Kilo release" vs git commit bc79c3ecc55929bac585d04a03475b72e06a3208``.
* Any deployment-specific information is helpful, such as whether you
are using Ubuntu 14.04 or are performing a multi-node installation.
The following Launchpad Bugs areas are available:
* `Bugs: OpenStack Block Storage
(cinder) <https://bugs.launchpad.net/cinder>`__
* `Bugs: OpenStack Compute (nova) <https://bugs.launchpad.net/nova>`__
* `Bugs: OpenStack Dashboard
(horizon) <https://bugs.launchpad.net/horizon>`__
* `Bugs: OpenStack Identity
(keystone) <https://bugs.launchpad.net/keystone>`__
* `Bugs: OpenStack Image service
(glance) <https://bugs.launchpad.net/glance>`__
* `Bugs: OpenStack Networking
(neutron) <https://bugs.launchpad.net/neutron>`__
* `Bugs: OpenStack Object Storage
(swift) <https://bugs.launchpad.net/swift>`__
* `Bugs: Application catalog (murano) <https://bugs.launchpad.net/murano>`__
* `Bugs: Bare metal service (ironic) <https://bugs.launchpad.net/ironic>`__
* `Bugs: Clustering service (senlin) <https://bugs.launchpad.net/senlin>`__
* `Bugs: Containers service (magnum) <https://bugs.launchpad.net/magnum>`__
* `Bugs: Data processing service
(sahara) <https://bugs.launchpad.net/sahara>`__
* `Bugs: Database service (trove) <https://bugs.launchpad.net/trove>`__
* `Bugs: Deployment service (fuel) <https://bugs.launchpad.net/fuel>`__
* `Bugs: DNS service (designate) <https://bugs.launchpad.net/designate>`__
* `Bugs: Key Manager Service (barbican) <https://bugs.launchpad.net/barbican>`__
* `Bugs: Monitoring (monasca) <https://bugs.launchpad.net/monasca>`__
* `Bugs: Orchestration (heat) <https://bugs.launchpad.net/heat>`__
* `Bugs: Rating (cloudkitty) <https://bugs.launchpad.net/cloudkitty>`__
* `Bugs: Shared file systems (manila) <https://bugs.launchpad.net/manila>`__
* `Bugs: Telemetry
(ceilometer) <https://bugs.launchpad.net/ceilometer>`__
* `Bugs: Telemetry v3
(gnocchi) <https://bugs.launchpad.net/gnocchi>`__
* `Bugs: Workflow service
(mistral) <https://bugs.launchpad.net/mistral>`__
* `Bugs: Messaging service
(zaqar) <https://bugs.launchpad.net/zaqar>`__
* `Bugs: OpenStack API Documentation
(developer.openstack.org) <https://bugs.launchpad.net/openstack-api-site>`__
* `Bugs: OpenStack Documentation
(docs.openstack.org) <https://bugs.launchpad.net/openstack-manuals>`__
The OpenStack IRC channel
~~~~~~~~~~~~~~~~~~~~~~~~~
The OpenStack community lives in the #openstack IRC channel on the
Freenode network. You can hang out, ask questions, or get immediate
feedback for urgent and pressing issues. To install an IRC client or use
a browser-based client, go to
`https://webchat.freenode.net/ <https://webchat.freenode.net>`__. You can
also use Colloquy (Mac OS X, http://colloquy.info/), mIRC (Windows,
http://www.mirc.com/), or XChat (Linux). When you are in the IRC channel
and want to share code or command output, the generally accepted method
is to use a Paste Bin. The OpenStack project has one at
http://paste.openstack.org. Just paste your longer amounts of text or
logs in the web form and you get a URL that you can paste into the
channel. The OpenStack IRC channel is ``#openstack`` on
``irc.freenode.net``. You can find a list of all OpenStack IRC channels
at https://wiki.openstack.org/wiki/IRC.
Documentation feedback
~~~~~~~~~~~~~~~~~~~~~~
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.
OpenStack distribution packages
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following Linux distributions provide community-supported packages
for OpenStack:
* **Debian:** https://wiki.debian.org/OpenStack
* **CentOS, Fedora, and Red Hat Enterprise Linux:**
https://www.rdoproject.org/
* **openSUSE and SUSE Linux Enterprise Server:**
https://en.opensuse.org/Portal:OpenStack
* **Ubuntu:** https://wiki.ubuntu.com/ServerTeam/CloudArchive

47
doc/common/conventions.rst Normal file
View File

@ -0,0 +1,47 @@
.. ## WARNING ##########################################################
.. This file is synced from openstack/openstack-manuals repository to
.. other related repositories. If you need to make changes to this file,
.. make the changes in openstack-manuals. After any change merged to,
.. openstack-manuals, automatically a patch for others will be proposed.
.. #####################################################################
===========
Conventions
===========
The OpenStack documentation uses several typesetting conventions.
Notices
~~~~~~~
Notices take these forms:
.. note:: A comment with additional information that explains a part of the
text.
.. important:: Something you must be aware of before proceeding.
.. tip:: An extra but helpful piece of practical advice.
.. caution:: Helpful information that prevents the user from making mistakes.
.. warning:: Critical information about the risk of data loss or security
issues.
Command prompts
~~~~~~~~~~~~~~~
.. code-block:: console
$ command
Any user, including the ``root`` user, can run commands that are
prefixed with the ``$`` prompt.
.. code-block:: console
# command
The ``root`` user must run commands that are prefixed with the ``#``
prompt. You can also prefix these commands with the :command:`sudo`
command, if available, to run them.

3940
doc/common/glossary.rst Normal file
View File

File diff suppressed because it is too large Load Diff

30
doc/ops-guide/setup.cfg Normal file
View File

@ -0,0 +1,30 @@
[metadata]
name = openstackopsguide
summary = OpenStack Operations Guide
author = OpenStack
author-email = openstack-docs@lists.openstack.org
home-page = http://docs.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Topic :: Documentation
[global]
setup-hooks =
pbr.hooks.setup_hook
[files]
[build_sphinx]
all_files = 1
build-dir = build
source-dir = source
[wheel]
universal = 1
[pbr]
warnerrors = True

30
doc/ops-guide/setup.py Normal file
View File

@ -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)

1
doc/ops-guide/source/common Symbolic link
View File

@ -0,0 +1 @@
../../common

289
doc/ops-guide/source/conf.py Normal file
View File

@ -0,0 +1,289 @@
# 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
import openstackdocstheme
# 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 = []
# 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.
project = u'Operations Guide'
bug_tag = u'ops-guide'
copyright = u'2016, 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 = '0.0.1'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
# A few variables have to be set for the log-a-bug feature.
# giturl: The location of conf.py on Git. Must be set manually.
# gitsha: The SHA checksum of the bug description. Automatically extracted from git log.
# bug_tag: Tag for categorizing the bug. Must be set manually.
# These variables are passed to the logabug code via html_context.
giturl = u'http://git.openstack.org/cgit/openstack/operations-guide/tree/doc/ops-guide/source'
git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '"
gitsha = os.popen(git_cmd).read().strip('\n')
html_context = {"gitsha": gitsha, "bug_tag": bug_tag,
"giturl": giturl}
# 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 = []
# 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
# "<project> v<release> 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.
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 <link> 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 = 'ops-guide'
# If true, publish source files
html_copy_source = False
# -- 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, or own class]).
latex_documents = [
('index', 'OpsGuide.tex', u'Operations 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', 'opsguide', u'Operations 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', 'OpsGuide', u'Operations Guide',
u'OpenStack contributors', 'OpsGuide',
'This book provides information about designing and operating '
'OpenStack clouds.', '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/']

28
doc/ops-guide/source/index.rst Normal file
View File

@ -0,0 +1,28 @@
==========================
OpenStack Operations Guide
==========================
Abstract
~~~~~~~~
This book provides information about designing and operating OpenStack clouds.
.. warning:: This guide is a work-in-progress and changing rapidly
while we continue to test and enhance this guide. Please note
where there are open "to do" items and help where you are able.
Contents
~~~~~~~~
.. toctree::
:maxdepth: 2
common/conventions.rst
common/app_support.rst
common/glossary.rst
Search in this guide
~~~~~~~~~~~~~~~~~~~~
* :ref:`search`

5
test-requirements.txt
View File

@ -1,4 +1,7 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstack-doc-tools>=0.23
openstack-doc-tools>=0.30
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
openstackdocstheme>=1.2.3
doc8 # Apache-2.0

6
tools/build-all-rst.sh Executable file
View File

@ -0,0 +1,6 @@
#!/bin/bash -e
mkdir -p publish-docs
doc-tools-build-rst doc/ops-guide --build build \
--target draft/ops-guide

42
tools/generatepot-rst.sh Executable file
View File

@ -0,0 +1,42 @@
#!/bin/bash -xe
#
# 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.
DOCNAME=$1
if [ -z "$DOCNAME" ] ; then
echo "usage $0 DOCNAME"
exit 1
fi
# We're not doing anything for this directory.
if [[ "$DOCNAME" = "common-rst" ]] ; then
exit 0
fi
rm -f doc/$DOCNAME/source/locale/$DOCNAME.pot
sphinx-build -b gettext doc/$DOCNAME/source/ doc/$DOCNAME/source/locale/
# common-rst is translated as part of openstack-manuals, do not
# include the file in the combined tree.
rm doc/$DOCNAME/source/locale/common.pot
# Take care of deleting all temporary files so that git add
# doc/$DOCNAME/source/locale will only add the single pot file.
# Remove UUIDs, those are not necessary and change too often
msgcat --sort-by-file doc/$DOCNAME/source/locale/*.pot | \
awk '$0 !~ /^\# [a-z0-9]+$/' > doc/$DOCNAME/source/$DOCNAME.pot
rm doc/$DOCNAME/source/locale/*.pot
rm -rf doc/$DOCNAME/source/locale/.doctrees/
mv doc/$DOCNAME/source/$DOCNAME.pot doc/$DOCNAME/source/locale/$DOCNAME.pot

51
tox.ini
View File

@ -8,7 +8,13 @@ basepython = python2
setenv =
VIRTUAL_ENV={envdir}
deps = -r{toxinidir}/test-requirements.txt
whitelist_externals = bash
whitelist_externals =
bash
cp
mkdir
rm
rsync
sed
[testenv:venv]
commands = {posargs}
@ -17,7 +23,9 @@ commands = {posargs}
commands = openstack-doc-test --check-links {posargs}
[testenv:checkniceness]
commands = openstack-doc-test --check-niceness {posargs}
commands =
openstack-doc-test --check-niceness {posargs}
doc8 doc
[testenv:checksyntax]
commands =
@ -29,21 +37,33 @@ commands =
commands = openstack-doc-test --check-deletions {posargs}
[testenv:checkbuild]
commands = openstack-doc-test --check-build {posargs}
commands =
# Build and copy RST Guides
{toxinidir}/tools/build-all-rst.sh
# This generates the current DocBook guide and index page
openstack-doc-test --check-build {posargs}
[testenv:publishdocs]
# Prepare all documents so that they can get
# published on docs.openstack.org with just copying publish-docs/*
# over.
commands = openstack-doc-test --check-build --nocreate-index --force
commands =
openstack-doc-test --check-build --nocreate-index --force
# Build and copy RST Guides
{toxinidir}/tools/build-all-rst.sh
[testenv:checklang]
# openstack-generate-docbook needs xml2po which cannot be installed in
# the venv. Since it's installed in the system, let's use
# sitepackages.
sitepackages=True
whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf test all
whitelist_externals =
doc-tools-check-languages
bash
commands =
doc-tools-check-languages doc-tools-check-languages.conf test all
# Check that .po and .pot files are valid:
bash -c "find doc -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
[testenv:buildlang]
# Run as "tox -e buildlang -- $LANG"
@ -61,3 +81,22 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf test {posarg
sitepackages=True
whitelist_externals = doc-tools-check-languages
commands = doc-tools-check-languages doc-tools-check-languages.conf publish all
[testenv:generatepot-rst]
# Generate POT files for translation, needs {posargs} like:
# tox -e generatepot-rst -- user-guide
commands = {toxinidir}/tools/generatepot-rst.sh {posargs}
[testenv:docs]
commands =
{toxinidir}/tools/build-all-rst.sh
[doc8]
# Settings for doc8:
# Ignore target directories
ignore-path = doc/*/target,doc/common
# File extensions to use
extensions = .rst,.txt
# Disable some doc8 checks:
# D000: Check RST validity (cannot handle lineos directive)
ignore = D000