Public bug reported: When running 'tox -e docs', the following warning occurs.
checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree The vendordata.rst has been added in the following patch. But it has no content (TODO description only) and is not linked by other documents. https://review.openstack.org//317739/ So orphan metadata should be added temporarily in /vendordata.rst. stack@devstack-master:/tmp/nova$ tox -e docs (snipped...) docs runtests: commands[1] | python setup.py build_sphinx running build_sphinx (snipped...) building [html]: all source files (snipped...) checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree done (snipped...) checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree done writing... nova-all.1 { } nova-api-metadata.1 { } nova-api-os-compute.1 { } nova-api.1 { } nova-cells.1 { } nova-cert.1 { } nova-compute.1 { } nova-console.1 { } nova-consoleauth.1 { } nova-dhcpbridge.1 { } nova-idmapshift.1 { } nova-manage.1 { } nova-network.1 { } nova-novncproxy.1 { } nova-spicehtml5proxy.1 { } nova-serialproxy.1 { } nova-rootwrap.1 { } nova-scheduler.1 { } nova-xvpvncproxy.1 { } nova-conductor.1 { } build succeeded, 1 warning. [Environment] OS: Ubuntu 14.04.4 LTS (64bit) nova master(commit: e6a05382bd257e74a81a551f23dc86ccb9ee01c5) ** Affects: nova Importance: Undecided Assignee: Takashi NATSUME (natsume-takashi) Status: New ** Tags: doc -- You received this bug notification because you are a member of Yahoo! Engineering Team, which is subscribed to OpenStack Compute (nova). https://bugs.launchpad.net/bugs/1611309 Title: 'WARNING: document isn't included in any toctree' in building html docs Status in OpenStack Compute (nova): New Bug description: When running 'tox -e docs', the following warning occurs. checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree The vendordata.rst has been added in the following patch. But it has no content (TODO description only) and is not linked by other documents. https://review.openstack.org//317739/ So orphan metadata should be added temporarily in /vendordata.rst. stack@devstack-master:/tmp/nova$ tox -e docs (snipped...) docs runtests: commands[1] | python setup.py build_sphinx running build_sphinx (snipped...) building [html]: all source files (snipped...) checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree done (snipped...) checking consistency... /tmp/nova/doc/source/vendordata.rst:: WARNING: document isn't included in any toctree done writing... nova-all.1 { } nova-api-metadata.1 { } nova-api-os-compute.1 { } nova-api.1 { } nova-cells.1 { } nova-cert.1 { } nova-compute.1 { } nova-console.1 { } nova-consoleauth.1 { } nova-dhcpbridge.1 { } nova-idmapshift.1 { } nova-manage.1 { } nova-network.1 { } nova-novncproxy.1 { } nova-spicehtml5proxy.1 { } nova-serialproxy.1 { } nova-rootwrap.1 { } nova-scheduler.1 { } nova-xvpvncproxy.1 { } nova-conductor.1 { } build succeeded, 1 warning. [Environment] OS: Ubuntu 14.04.4 LTS (64bit) nova master(commit: e6a05382bd257e74a81a551f23dc86ccb9ee01c5) To manage notifications about this bug go to: https://bugs.launchpad.net/nova/+bug/1611309/+subscriptions -- Mailing list: https://launchpad.net/~yahoo-eng-team Post to : yahoo-eng-team@lists.launchpad.net Unsubscribe : https://launchpad.net/~yahoo-eng-team More help : https://help.launchpad.net/ListHelp
