[openstack-dev] [api][os-api-ref] openstackdocstheme integration

Doug Hellmann doug at doughellmann.com
Mon Aug 8 12:44:12 UTC 2016


Excerpts from Hayes, Graham's message of 2016-08-08 11:28:35 +0000:
> On 05/08/2016 19:15, Doug Hellmann wrote:
> > Excerpts from Hayes, Graham's message of 2016-08-05 17:04:35 +0000:
> >> Hey,
> >>
> >> We look like we are getting close to merging the os-api-ref integration
> >> with openstackdocstheme.
> >>
> >> Unfortunately, there is no "phased" approach available - the version
> >> released with compatibility for openstackdocstheme will not work
> >> with oslo.sphinx.
> >
> > In what way doesn't it work? Is one of the themes missing something?
> >
> > Doug
> 
> Both themes are laid out differently. One uses bootstrap and the other
> doesn't, one has a different view on what should be hidden, and where
> TOCs belong.
> 
> The end result was that for the oslosphinx integration we included extra
> CSS / JS, but that code can cause conflicts with openstackdocstheme.

Would putting that extra stuff into oslosphinx, as an optional part of
the them, make the transition any easier?

Doug

> 
> As one theme already uses bootstrap, the css (and the classes applied
> to the HTML elements) has to be modified, and is incompatible with the
> old theme, as it was only using the sideloaded bootstrap css in a
> section of the page.
> 
> The review for the integration is here:
> 
> https://review.openstack.org/#/c/322430/
> 
> - Graham
> 
> >
> >> So, we need a way to use oslosphinx until it is released, and the new
> >> theme after it is released.
> >>
> >>
> >> I suggest we put a temporary section of code in the `conf.py` of each
> >> project using os-api-ref - I have a WIP preview for designate up for
> >> review [0]
> >>
> >> Can I get some feedback, if people think this is a good way forward?
> >>
> >> The list of repos I have using os-api-ref is (from [1]:
> >>
> >> openstack/networking-sfc
> >> openstack/ceilometer
> >> openstack/glance
> >> openstack/heat
> >> openstack/ironic
> >> openstack/keystone
> >> openstack/manila
> >> openstack/designate
> >> openstack/neutron-lib
> >> openstack/nova
> >> openstack/sahara
> >> openstack/searchlight
> >> openstack/senlin
> >> openstack/swift
> >> openstack/zaqar
> >>
> >> Thanks,
> >>
> >> Graham
> >>
> >> 0 - https://review.openstack.org/#/c/351800/
> >> 1 -
> >> http://codesearch.openstack.org/?q=os_api_ref&i=nope&files=api-ref%2Fsource%2Fconf.py&repos=
> >>
> >
> > __________________________________________________________________________
> > OpenStack Development Mailing List (not for usage questions)
> > Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> >
> 



More information about the OpenStack-dev mailing list