[OpenStack-docs] Sphinx theme for docs.openstack.org

Andreas Jaeger aj at suse.com
Wed Jan 21 07:36:00 UTC 2015


On 01/19/2015 04:05 PM, Anne Gentle wrote:
> Hi all,
> I've been researching the Sphinx theme approach to get our new web
> design in place for the content pages themselves. The landing page is
> complete, using the jinja2 templates. [1] 
> 
> I've learned a few things I want to share and these things bring me to
> look for a slightly different approach than I have in the original
> blueprint.
> 
> The header for www.openstack.org <http://www.openstack.org> has always
> matched docs.openstack.org <http://docs.openstack.org> and should
> continue to do so.
> 
> The docs team will likely have to debug any CSS/JS problems with the
> templates.
> 
> Outside of docs, we have ci.openstack.org <http://ci.openstack.org>,
> specs.openstack.org <http://specs.openstack.org>, and
> governance.openstack.org <http://governance.openstack.org> using the
> current oslosphinx theme. They've modified the header in some cases. So
> there's reasoning to keep the current oslosphinx theme as-is.
> 
> The oslosphinx theme is a theme in itself and it's not straightforward
> to just add a second extension to it that could be used for
> docs.openstack.org <http://docs.openstack.org>. Well it's six of one,
> half dozen of the other, but in discovering there may be a need to keep
> oslosphinx as-is, and for maintenance, it makes sense to build our own
> openstack-docs theme in a separate library. 
> 
> In the discovery phase, I've put this patch together [2].
> 
> In looking at all the overlap between the jinja2 templates and CSS, it
> is definitely more efficient to try to maintain all those files
> together. I think a separate repo is the way to go.
> 
> Does that sound okay to you all? Please reply here and/or vote on [3].

Separate repository works fine for me - and has the advantage that other
sites could reuse it more easily,

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,
       Graham Norton, HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list