x
/
fuel-plugin-kafka
Code Issues Proposed changes

Add an ability to build docs using tox 

It is possible to use "tox -edocs"

Change-Id: I427d78265e37aff256eecaf6d2fd12eb0a9a725e
This commit is contained in:
Nadya Privalova 2016-08-31 12:04:34 +03:00 committed by Nadya Shakhat
parent 7764e6c4fe
commit f828aa6b34
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/description.rst
View File

@ -22,7 +22,7 @@ Requirements
======================= ================ ======================= ================
Requirements Version/Comment Requirements Version/Comment
======================= ================ ======================= ================
MOS 9.0 Mirantis OpenStack 9.x
======================= ================ ======================= ================
.. _limitations: .. _limitations:
@ -32,10 +32,8 @@ Limitations
* Kafka supports authentication, encryption and authorization. Current version of the * Kafka supports authentication, encryption and authorization. Current version of the
plugin doesn't support any form of security, meaning that the Kafka cluster will be plugin doesn't support any form of security, meaning that the Kafka cluster will be
“open” on the management network. We plan to support some level of security in future “open” on the management network.
versions of the plugin.
* Kafka Plugin will not expose configuration properties for all the broker configuration parameters. * Kafka Plugin will not expose configuration properties for all the broker configuration parameters.
This means that the Kafka broker configuration set by the plugin will not be appropriate for every This means that the Kafka broker configuration set by the plugin will not be appropriate for every
usage. In the future, we may make the Fuel plugin more configurable by adding new configuration usage.
properties.

8
tox.ini
View File

@ -1,5 +1,5 @@
[tox] [tox]
envlist = manifests,build_plugin envlist = manifests,build_plugin,docs
skipsdist = True skipsdist = True
[testenv] [testenv]
@ -17,6 +17,12 @@ commands =
bundle install --path {toxinidir}/.bundled_gems bundle install --path {toxinidir}/.bundled_gems
bundle exec rake test bundle exec rake test
[testenv:docs]
changedir = {toxinidir}/docs
whitelist_externals = make
commands =
make clean html SPHINXOPTS=-W
[testenv:build_plugin] [testenv:build_plugin]
changedir = {toxinidir} changedir = {toxinidir}
whitelist_externals = whitelist_externals =