Double dots in the API docs are causing broken links on nova.openstack.org

Bug #693464 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Medium
Todd Willey

Bug Description

When you browse directly to http://nova.openstack.org/devref/ and then click one of the Module links under the API Reference heading, all the URLs have too many periods, causing a broken link.

For example, http://nova.openstack.org/api/nova..adminclient.html should be http://nova.openstack.org/api/nova.adminclient.html.

Hopefully it's just a problem with the Sphinx build params somehow adding an extra period.

Related branches

Thierry Carrez (ttx)
Changed in nova:
importance: Undecided → Medium
status: New → Confirmed
tags: added: documentation
Revision history for this message
Anne Gentle (annegentle) wrote :

Looks like there are extra periods in all the rst file names in the /api directory.

I'm unsure of how to do mass renames, and this didn't work - any one else have more ideas?

ls -d nova..* | sed 's/\(.*\)nova..$/sed "s\/\\nova..\/nova.\/g" "&" > \1.rst' | sh

gave me:
sed: 1: "s/\(.*\)nova..$/sed "s\ ...": unterminated substitute in regular expression

so I might need more escape characters for the extra period?

Thanks for any assistance.

Revision history for this message
Anne Gentle (annegentle) wrote :

Nevermind, I renamed all the files from nova.. to nova. and then autodoc renamed them back. I'd love help troubleshooting this behavior.

Todd Willey (xtoddx)
Changed in nova:
assignee: nobody → Todd Willey (xtoddx)
Revision history for this message
Todd Willey (xtoddx) wrote :

I think the autogenerated files should not be added into bzr. Running `make clean` in the doc directory made the next run of `python setup.py build_sphinx` work like a charm. I've committed a branch with the autogenerated file cleaned out so we can all share in the fun.

Thierry Carrez (ttx)
Changed in nova:
status: Confirmed → In Progress
Thierry Carrez (ttx)
Changed in nova:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in nova:
milestone: none → 2011.1
status: Fix Committed → Fix Released
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.