yahoo-eng-team team mailing list archive

[Pasquale Porreca <pasquale.porreca@xxxxxxxxxxxxxx>]

Public bug reported:

When a new specification is submitted for nova, it should stay in the
directory nova-specs/specs/kilo/ anyway this toctree is not present in
nova-specs/doc/source/index.rst (it includes only specs/kilo/approved/*)
this leads to the error sphinx.errors.SphinxWarning: nova-
specs/doc/source/specs/kilo/new-spec.rst:: WARNING: document isn't
included in any toctree

This bug is similar (basically the same bug) reported and resolved for
ironic-specs: https://bugs.launchpad.net/ironic/+bug/1379415

The solution for nova-specs is the same implemented for ironic-specs:
include a toctree for specs/kilo/* in nova-specs/doc/source/index.rst
and a dummy rst file in the directory nova-specs/doc/source/specs/kilo/
(otherwise sphinx will complain because the specs/kilo/* pattern didn't
match any documents)

** Affects: nova
     Importance: Undecided
     Assignee: Pasquale Porreca (pasquale-porreca)
         Status: New


** Tags: nova-specs

** Changed in: nova
     Assignee: (unassigned) => Pasquale Porreca (pasquale-porreca)

-- 
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/1384642

Title:
  sphinx errors when adding specs to kilo in nova-specs

Status in OpenStack Compute (Nova):
  New

Bug description:
  When a new specification is submitted for nova, it should stay in the
  directory nova-specs/specs/kilo/ anyway this toctree is not present in
  nova-specs/doc/source/index.rst (it includes only
  specs/kilo/approved/*) this leads to the error
  sphinx.errors.SphinxWarning: nova-specs/doc/source/specs/kilo/new-
  spec.rst:: WARNING: document isn't included in any toctree

  This bug is similar (basically the same bug) reported and resolved for
  ironic-specs: https://bugs.launchpad.net/ironic/+bug/1379415

  The solution for nova-specs is the same implemented for ironic-specs:
  include a toctree for specs/kilo/* in nova-specs/doc/source/index.rst
  and a dummy rst file in the directory nova-
  specs/doc/source/specs/kilo/ (otherwise sphinx will complain because
  the specs/kilo/* pattern didn't match any documents)

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1384642/+subscriptions