Open Stack

First, I hope it's OK if a newbie uses this mailing list to request help for
bug fixing. If there are better ways, please let me know.

 

The bug in question is
https://bugs.launchpad.net/openstack-manuals/+bug/1421799. It's a request to
add a "log a bug" link to the openstackdocstheme templates, similar to the
cute red bug links at the top and bottom of each page in the current
DocBook-based documentation.

 

I recklessly assigned this bug to myself. While I should be able to put the
mechanism in place, I don't have enough information to construct the link
into launchpad and could do with some help from knowledgeable people.

 

In the current documentation, the bug link is a launchpad URL that contains
the book title (such as "SLES 11 installation guide") and information of the
following form:

 

-----------------------------------
Built: 2015-02-17T17:45:22 00:00
git SHA: 3f5dd2abd6d6f94cfffcb26f88c830da38af5d9e
URL:
http://docs.openstack.org/juno/config-reference/content/section_compute-sche
duler.html
source File:
file:/home/jenkins/workspace/openstack-manuals-tox-doc-publishdocs/doc/confi
g-reference/compute/section_compute-scheduler.xml
xml:id: section_compute-scheduler

 

My question is: Where would I find equivalent information in the
Sphinx/Jinja environment? 

The Sphinx documentation lists a few promising helper functions and
variables (http://sphinx-doc.org/templating.html#helper-functions). It seems
that some settings are derived from conf.py, and I don't know if there is
any conf.py standard that I can base this on.

No idea how to retrieve the SHA key, and what to use instead of the XML ID
(or can it just be left out).

 

Rather than asking for help, I could also just implement whatever I can and
leave a few gaps for more experienced people or reviewers. Is that an
acceptable approach?

 

Regards,

 

Bernd

Bernd Bausch

berndbausch at gmail.com <mailto:berndbausch at gmail.com> 

+81 80 8892 5564

 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150226/3965e9e5/attachment.html>