Added sphnix build folder location

Added sphnix build folder location. Added Ocata implemented specs.
Fix registered sign character.

Change-Id: I27a8db968dbb029f370f46b77f3d2be1d85a45ca
This commit is contained in:
Luz Cazares 2017-03-16 22:25:45 +00:00 committed by Dolph Mathews
parent f70ac93713
commit 057c7c2f11
5 changed files with 31 additions and 16 deletions

View File

@ -98,7 +98,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'default' html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the

View File

@ -12,7 +12,7 @@ Overview
-------- --------
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 2
README README
refstack refstack
@ -41,8 +41,17 @@ Specs
specs/mitaka/implemented/* specs/mitaka/implemented/*
**Implemented in the Ocata Cycle**
.. toctree::
:maxdepth: 1
:glob:
specs/ocata/implemented/*
------------------
Indices and tables Indices and tables
================== ------------------
* :ref:`search` * :ref:`search`

View File

@ -33,3 +33,9 @@ setup-hooks =
[entry_points] [entry_points]
oslo.config.opts = oslo.config.opts =
refstack = refstack.opts:list_opts refstack = refstack.opts:list_opts
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source

View File

@ -85,26 +85,26 @@ the system, "name" and "version" are user input fields. A row with two users
input fields are created each time for a new product or a new version for an input fields are created each time for a new product or a new version for an
existing product. existing product.
In the following examples, Are "ABC OpenStack®" and "ABC OpenStack" one or two
.. |reg| unicode:: U+00AE .. REGISTERED SIGN
In the following examples, Are "ABC OpenStack\ |reg|." and "ABC OpenStack" one or two
different products? different products?
* It could be one product because the users had made a mistake when creating a * It could be one product because the users had made a mistake when creating a
new version for the existing "ABC OpenStack®" product. new version for the existing "ABC OpenStack\ |reg|." product.
* It could also be two products, since the 2 names are not the same. * It could also be two products, since the 2 names are not the same.
Such kind of data integrity and consistency issues should be avoid whenever Such kind of data integrity and consistency issues should be avoid whenever
possible with appropriate database design and/or bussiness layer code. possible with appropriate database design and/or bussiness layer code.
+------------+------------------+----------+ ========== =================== =======
| product_id | Name | Version | product_id Name Version
+============+==================+==========+ ========== =================== =======
| 11111 | ABC OpenStack® | v6.0 | 11111 ABC OpenStack |reg| v6.0
+------------+------------------+----------+ 22222 ABC OpenStack v7.0
| 22222 | ABC OpenStack | v7.0 | 33333 ABC OpenStack |reg| v8.0
+------------+------------------+----------+ ========== =================== =======
| 33333 | ABC OpenStack® | v8.0 |
+------------+------------------+----------+
Data model impact Data model impact
----------------- -----------------

View File

@ -53,7 +53,7 @@ commands = python setup.py testr --coverage \
commands = {toxinidir}/tools/cover.sh {posargs} commands = {toxinidir}/tools/cover.sh {posargs}
[testenv:docs] [testenv:docs]
commands = python setup.py build_sphinx commands = python setup.py build_sphinx {posargs}
[flake8] [flake8]
# E125 continuation line does not distinguish itself from next logical line # E125 continuation line does not distinguish itself from next logical line