Warnings about nova-status.rst and config in Document generation

Bug #1659485 reported by Takashi Natsume
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
Takashi Natsume

Bug Description

When executing 'tox -e docs', the following warnings are output.

* WARNING:stevedore.named:Could not load nova.api, nova.cells
* /tmp/nova/doc/source/man/nova-status.rst:66: WARNING: Literal block expected; none found.
* /tmp/nova/doc/source/man/nova-status.rst:73: WARNING: Enumerated list ends without a blank line;

The warnings about nova-status.rst are related with code block.
But it had better be replaced with a table.

-----
stack@devstack-master:/tmp/nova$ tox -e docs
docs create: /tmp/nova/.tox/docs
docs installdeps: -r/tmp/nova/test-requirements.txt
docs develop-inst: /tmp/nova
docs installed: alabaster==0.7.9,alembic==0.8.10,amqp==1.4.9,anyjson==0.3.3,appdirs==1.4.0,Babel==2.3.4,bandit==1.4.0,cachetools==2.0.0,castellan==0.5.0,cffi==1.9.1,cliff==2.4.0,cmd2==0.6.9,colorama==0.3.7,contextlib2==0.5.4,coverage==4.3.4,cryptography==1.7.1,ddt==1.1.1,debtcollector==1.11.0,decorator==4.0.11,docutils==0.12,dogpile.cache==0.6.2,dulwich==0.16.3,enum34==1.1.6,eventlet==0.19.0,extras==1.0.0,fasteners==0.14.1,fixtures==3.0.0,flake8==2.2.4,funcsigs==1.0.2,functools32==3.2.3.post2,futures==3.0.5,futurist==0.21.0,gabbi==1.31.0,gitdb2==2.0.0,GitPython==2.1.1,greenlet==0.4.11,hacking==0.10.2,httplib2==0.9.2,idna==2.2,ipaddress==1.0.18,iso8601==0.1.11,Jinja2==2.8.1,jsonpatch==1.15,jsonpath-rw==1.4.0,jsonpath-rw-ext==1.0.0,jsonpointer==1.10,jsonschema==2.5.1,keystoneauth1==2.18.0,keystonemiddleware==4.14.0,kombu==3.0.37,linecache2==1.0.0,lxml==3.7.2,Mako==1.0.6,MarkupSafe==0.23,mccabe==0.2.1,microversion-parse==0.1.4,mock==2.0.0,monotonic==1.2,mox3==0.20.0,msgpack-python==0.4.8,netaddr==0.7.19,netifaces==0.10.5,-e git+https://git.openstack.org/openstack/nova.git@5f59c0e3c61cd6f0600de3a69eeef2037358b782#egg=nova,numpy==1.12.0,openstackdocstheme==1.6.1,openstacksdk==0.9.10,os-api-ref==1.2.0,os-brick==1.11.0,os-client-config==1.26.0,os-testr==0.8.0,os-vif==1.4.0,os-win==1.4.0,os-xenapi==0.1.1,osc-lib==1.3.0,oslo.cache==1.17.0,oslo.concurrency==3.18.0,oslo.config==3.22.0,oslo.context==2.11.0,oslo.db==4.17.0,oslo.i18n==3.12.0,oslo.log==3.20.0,oslo.messaging==5.17.0,oslo.middleware==3.23.0,oslo.policy==1.18.0,oslo.privsep==1.16.0,oslo.reports==1.17.0,oslo.rootwrap==5.4.0,oslo.serialization==2.16.0,oslo.service==1.19.0,oslo.utils==3.22.0,oslo.versionedobjects==1.21.0,oslo.vmware==2.17.0,oslosphinx==4.10.0,oslotest==2.13.0,osprofiler==1.5.0,packaging==16.8,paramiko==2.1.1,Paste==2.0.3,PasteDeploy==1.5.2,pbr==1.10.0,pep8==1.5.7,pika==0.10.0,pika-pool==0.1.3,ply==3.9,positional==1.1.1,prettytable==0.7.2,psutil==5.0.1,psycopg2==2.6.2,py==1.4.32,pyasn1==0.1.9,pycadf==2.5.0,pycparser==2.17,pyflakes==0.8.1,Pygments==2.2.0,pyinotify==0.9.6,PyMySQL==0.7.9,pyparsing==2.1.10,pytest==3.0.6,python-barbicanclient==4.1.0,python-cinderclient==1.10.0,python-dateutil==2.6.0,python-editor==1.0.3,python-glanceclient==2.6.0,python-ironicclient==1.10.0,python-keystoneclient==3.9.0,python-mimeparse==1.6.0,python-neutronclient==6.1.0,python-novaclient==6.0.0,python-openstackclient==3.7.0,python-subunit==1.2.0,pytz==2016.10,PyYAML==3.12,reno==2.0.3,repoze.lru==0.6,requests==2.12.5,requests-mock==1.2.0,requestsexceptions==1.1.3,retrying==1.3.3,rfc3986==0.4.1,Routes==2.4.1,simplejson==3.10.0,six==1.10.0,smmap2==2.0.1,snowballstemmer==1.2.1,Sphinx==1.3.6,sphinx-rtd-theme==0.1.9,SQLAlchemy==1.0.17,sqlalchemy-migrate==0.10.0,sqlparse==0.2.2,statsd==3.2.1,stevedore==1.19.1,suds-jurko==0.6,tempest-lib==1.0.0,Tempita==0.5.2,tenacity==3.7.1,testrepository==0.0.20,testresources==2.0.1,testscenarios==0.5.0,testtools==2.2.0,traceback2==1.4.0,unicodecsv==0.14.1,unittest2==1.1.0,urllib3==1.20,warlock==1.2.0,WebOb==1.6.3,websockify==0.8.0,wrapt==1.10.8,wsgi-intercept==1.4.1
docs runtests: PYTHONHASHSEED='1259549316'
docs runtests: commands[0] | rm -rf doc/source/api doc/build api-guide/build api-ref/build
docs runtests: commands[1] | python setup.py build_sphinx
running build_sphinx
creating /tmp/nova/doc/build
creating /tmp/nova/doc/build/doctrees
creating /tmp/nova/doc/build/html
[pbr] Writing ChangeLog
[pbr] Generating ChangeLog
[pbr] ChangeLog complete (1.4s)
[pbr] Generating AUTHORS
[pbr] AUTHORS complete (1.9s)
Running Sphinx v1.3.6
loading pickled environment... not yet created
Using openstack theme from /tmp/nova/.tox/docs/local/lib/python2.7/site-packages/oslosphinx/theme
[oslo_config.sphinxconfiggen] reading config generator instructions from /tmp/nova/doc/source/../../etc/nova/nova-config-generator.conf
[oslo_config.sphinxconfiggen] writing sample configuration to /tmp/nova/doc/source/_static/nova.conf.sample
WARNING:stevedore.named:Could not load nova.api, nova.cells
[oslo_policy.sphinxpolicygen] reading config generator instructions from /tmp/nova/doc/source/../../etc/nova/nova-policy-generator.conf
[oslo_policy.sphinxpolicygen] writing sample policy to /tmp/nova/doc/source/_static/nova.policy.yaml.sample
building [mo]: all of 0 po files
building [html]: all source files
updating environment: 60 added, 0 changed, 0 removed
reading sources... [100%] vmstates
/tmp/nova/doc/source/man/nova-status.rst:66: WARNING: Literal block expected; none found.
/tmp/nova/doc/source/man/nova-status.rst:73: WARNING: Enumerated list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] vmstates
generating indices... genindex
writing additional pages... search
copying images... [100%] ./images/rpc/arch.png
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build succeeded, 2 warnings.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/425549

Changed in nova:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/425549
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=1585ca189eb6e194441f9dff94c7a710d96e1acc
Submitter: Jenkins
Branch: master

commit 1585ca189eb6e194441f9dff94c7a710d96e1acc
Author: Takashi NATSUME <email address hidden>
Date: Thu Jan 26 14:25:22 2017 +0900

    Fix doc generation warnings

    Fix the following warnings.

    - A warning in config sample generation
    - Warnings about nova-status.rst

    Change-Id: Ifcc3b4a89eeea9d0dd62e2a8b560c5e6a9ff3d1a
    Closes-Bug: #1659485

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/ocata)

Fix proposed to branch: stable/ocata
Review: https://review.openstack.org/441853

Tony Breeds (o-tony)
Changed in nova:
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (stable/ocata)

Reviewed: https://review.openstack.org/441853
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=11fc6a370b1fe96b4e9ae167e17d48359af213bc
Submitter: Jenkins
Branch: stable/ocata

commit 11fc6a370b1fe96b4e9ae167e17d48359af213bc
Author: Takashi NATSUME <email address hidden>
Date: Thu Jan 26 14:25:22 2017 +0900

    Fix doc generation warnings

    Fix the following warnings.

    - A warning in config sample generation
    - Warnings about nova-status.rst

    Change-Id: Ifcc3b4a89eeea9d0dd62e2a8b560c5e6a9ff3d1a
    Closes-Bug: #1659485
    (cherry picked from commit 1585ca189eb6e194441f9dff94c7a710d96e1acc)

tags: added: in-stable-ocata
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 15.0.1

This issue was fixed in the openstack/nova 15.0.1 release.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 16.0.0.0b1

This issue was fixed in the openstack/nova 16.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.