OpenStack Neutron (virtual network service)

Documentation build is broken

Reported by Maru Newby on 2012-05-05
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Core Infrastructure
High
Unassigned
neutron
Undecided
Gary Kotton

Bug Description

It is not possible to build the quantum docs without error. When this is resolved, the associated jenkins job (https://jenkins.openstack.org/job/quantum-docs/) should be added to the jobs that gate quantum commits to prevent regression.

$ python setup.py build_sphinx
running build_sphinx
Running Sphinx v1.1.3
loading pickled environment... not yet created
Traceback (most recent call last):
  File "setup.py", line 105, in <module>
    'quantum-server = quantum.server:main',
  File "/usr/lib/python2.6/distutils/core.py", line 152, in setup
    dist.run_commands()
  File "/usr/lib/python2.6/distutils/dist.py", line 975, in run_commands
    self.run_command(cmd)
  File "/usr/lib/python2.6/distutils/dist.py", line 995, in run_command
    cmd_obj.run()
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/setup_command.py", line 140, in run
    freshenv=self.fresh_env)
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/application.py", line 134, in __init__
    self._init_builder(buildername)
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/application.py", line 194, in _init_builder
    self.builder = builderclass(self)
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/__init__.py", line 57, in __init__
    self.init()
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/html.py", line 94, in init
    self.init_templates()
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/html.py", line 129, in init_templates
    self.theme = Theme(themename)
  File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/theming.py", line 65, in __init__
    '(missing theme.conf?)' % name)
sphinx.errors.ThemeError: no theme named '_theme' found (missing theme.conf?)

Hi,
A few weeks ago I started to work on something like this. I think that
it should also cover the MAN pages for the quantum processes that run. I
wrote https://blueprints.launchpad.net/quantum/+spec/man-support (I have
yet to complete it).
Thanks
Gary

On 05/06/2012 01:26 AM, Maru Newby wrote:
> Public bug reported:
>
> It is not possible to build the quantum docs without error. When this
> is resolved, the associated jenkins job
> (https://jenkins.openstack.org/job/quantum-docs/) should be added to the
> jobs that gate quantum commits to prevent regression.
>
> $ python setup.py build_sphinx
> running build_sphinx
> Running Sphinx v1.1.3
> loading pickled environment... not yet created
> Traceback (most recent call last):
> File "setup.py", line 105, in<module>
> 'quantum-server = quantum.server:main',
> File "/usr/lib/python2.6/distutils/core.py", line 152, in setup
> dist.run_commands()
> File "/usr/lib/python2.6/distutils/dist.py", line 975, in run_commands
> self.run_command(cmd)
> File "/usr/lib/python2.6/distutils/dist.py", line 995, in run_command
> cmd_obj.run()
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/setup_command.py", line 140, in run
> freshenv=self.fresh_env)
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/application.py", line 134, in __init__
> self._init_builder(buildername)
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/application.py", line 194, in _init_builder
> self.builder = builderclass(self)
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/__init__.py", line 57, in __init__
> self.init()
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/html.py", line 94, in init
> self.init_templates()
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/builders/html.py", line 129, in init_templates
> self.theme = Theme(themename)
> File "/home/maru/os_env/lib/python2.6/site-packages/sphinx/theming.py", line 65, in __init__
> '(missing theme.conf?)' % name)
> sphinx.errors.ThemeError: no theme named '_theme' found (missing theme.conf?)
>
> ** Affects: openstack-ci
> Importance: Undecided
> Status: New
>
> ** Affects: quantum
> Importance: Undecided
> Status: New
>
> ** Also affects: openstack-ci
> Importance: Undecided
> Status: New
>

Changed in quantum:
assignee: nobody → Gary Kotton (garyk)
status: New → In Progress
dan wendlandt (danwent) wrote :

Fixing this up will be a great help to the community. Quantum has never had functioning sphinx documentation builds.

Once this is working, we can get the results posted to http://quantum.openstack.org, just like for other projects like http://nova.openstack.org/ .

Thierry Carrez (ttx) wrote :
Changed in quantum:
milestone: none → folsom-1
status: In Progress → Fix Released
James E. Blair (corvus) on 2012-06-22
Changed in openstack-ci:
status: New → Triaged
importance: Undecided → High
milestone: none → folsom
Clark Boylan (cboylan) wrote :

I think this can be marked fix released under the openstack-ci bug tracker as well. Docs are getting build and are uploaded to http://docs.openstack.org/developer/quantum/. Might want to add a link to the quantum docs here http://docs.openstack.org/developer/

Monty Taylor (mordred) on 2012-08-06
Changed in openstack-ci:
status: Triaged → Fix Released
Thierry Carrez (ttx) on 2012-09-27
Changed in quantum:
milestone: folsom-1 → 2012.2
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers