dn2osdbk doesn't handle internal RST references properly

Bug #1378073 reported by Gauvain Pocentek
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
High
Gauvain Pocentek

Bug Description

Everything's in the summary.

Tags: doc-tools
Changed in openstack-manuals:
importance: Undecided → High
assignee: nobody → Gauvain Pocentek (gpocentek)
tags: added: doc-tools
Revision history for this message
Tom Fifield (fifieldt) wrote :

Hi Gauvain,

I think you're probably going to solve this bug, but just in case you can't I'm going to mark it incomplete, as I think some more context might be required. For example, where is dn2osdbk used?

Changed in openstack-manuals:
status: New → Incomplete
Revision history for this message
Gauvain Pocentek (gpocentek) wrote :

I thought I'd take care of this sooner, but heh...

dn2osdbk is the tools that converts RST to docbook for us. It is only used to build the HOT guide for now.

The internal reference written in the RST file (:ref:...) generate broken links when converted to docbook (see http://docs.openstack.org/hot-guide/content/hello_world_template-outputs.html, last paragraph).

Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: Incomplete → Confirmed
Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-doc-tools (master)

Reviewed: https://review.openstack.org/127720
Committed: https://git.openstack.org/cgit/openstack/openstack-doc-tools/commit/?id=f24863cf4d6f91dcda9a5ece975593c9b3bcce05
Submitter: Jenkins
Branch: master

commit f24863cf4d6f91dcda9a5ece975593c9b3bcce05
Author: Gauvain Pocentek <email address hidden>
Date: Sat Oct 11 07:29:11 2014 +0200

    dn2osdbk: handle internal references

    The internal references were not properly created. This patches make the
    :ref: inline markup create a <xref> tag when the reference is internal.

    This patch also reworks the sphinx extension to handle the URLs that
    will be generated in the hot-reference with the new :ref: behavior.

    Closes-Bug: #1378073
    Change-Id: I84bf268dc1055dc6b39f23c4415734184ec57eec

Changed in openstack-manuals:
status: In Progress → 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.