From 057c7c2f11ffe233df3d56411a0d8d74075198d7 Mon Sep 17 00:00:00 2001 From: Luz Cazares Date: Thu, 16 Mar 2017 22:25:45 +0000 Subject: [PATCH] Added sphnix build folder location Added sphnix build folder location. Added Ocata implemented specs. Fix registered sign character. Change-Id: I27a8db968dbb029f370f46b77f3d2be1d85a45ca --- doc/source/conf.py | 2 +- doc/source/index.rst | 13 ++++++++-- setup.cfg | 6 +++++ .../product-version-datamodel-api.rst | 24 +++++++++---------- tox.ini | 2 +- 5 files changed, 31 insertions(+), 16 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 60897df2..8f9276d5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -98,7 +98,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the diff --git a/doc/source/index.rst b/doc/source/index.rst index e2ab11b0..ec2e28ae 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,7 +12,7 @@ Overview -------- .. toctree:: - :maxdepth: 3 + :maxdepth: 2 README refstack @@ -41,8 +41,17 @@ Specs specs/mitaka/implemented/* +**Implemented in the Ocata Cycle** + +.. toctree:: + :maxdepth: 1 + :glob: + + specs/ocata/implemented/* + +------------------ Indices and tables -================== +------------------ * :ref:`search` diff --git a/setup.cfg b/setup.cfg index 570c193d..c8a127cc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -33,3 +33,9 @@ setup-hooks = [entry_points] oslo.config.opts = refstack = refstack.opts:list_opts + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + diff --git a/specs/newton/implemented/product-version-datamodel-api.rst b/specs/newton/implemented/product-version-datamodel-api.rst index 7f186d23..52b063ad 100755 --- a/specs/newton/implemented/product-version-datamodel-api.rst +++ b/specs/newton/implemented/product-version-datamodel-api.rst @@ -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 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? * 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. Such kind of data integrity and consistency issues should be avoid whenever possible with appropriate database design and/or bussiness layer code. -+------------+------------------+----------+ -| product_id | Name | Version | -+============+==================+==========+ -| 11111 | ABC OpenStack® | v6.0 | -+------------+------------------+----------+ -| 22222 | ABC OpenStack | v7.0 | -+------------+------------------+----------+ -| 33333 | ABC OpenStack® | v8.0 | -+------------+------------------+----------+ - +========== =================== ======= +product_id Name Version +========== =================== ======= +11111 ABC OpenStack |reg| v6.0 +22222 ABC OpenStack v7.0 +33333 ABC OpenStack |reg| v8.0 +========== =================== ======= Data model impact ----------------- diff --git a/tox.ini b/tox.ini index 68181ca1..529e8956 100644 --- a/tox.ini +++ b/tox.ini @@ -53,7 +53,7 @@ commands = python setup.py testr --coverage \ commands = {toxinidir}/tools/cover.sh {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = python setup.py build_sphinx {posargs} [flake8] # E125 continuation line does not distinguish itself from next logical line