[openstack-dev] Adding "not docs" banner to specs website?
doug at doughellmann.com
Mon Mar 19 20:09:14 UTC 2018
Excerpts from Jim Rollenhagen's message of 2018-03-19 19:06:38 +0000:
> On Mon, Mar 19, 2018 at 3:46 PM, Jeremy Stanley <fungi at yuggoth.org> wrote:
> > On 2018-03-19 14:57:58 +0000 (+0000), Jim Rollenhagen wrote:
> > [...]
> > > What do folks think about a banner at the top of the specs website
> > > (or each individual spec) that points this out? I'm happy to do
> > > the work if we agree it's a good thing to do.
> > [...]
> > Sounds good in principle, but the execution may take a bit of work.
> > Specs sites are independently generated Sphinx documents stored in
> > different repositories managed by different teams, and don't
> > necessarily share a common theme or configuration.
> Huh, I had totally thought there was a theme for the specs site that
> most/all projects use. I may try to accomplish this anyway, but will likely
> be more work that I thought. I'll poke around at options (small sphinx
> plugin, etc).
We want them all to use the openstackdocstheme so you could look
into creating a "subclass" of that one with the extra content in
the header, then ensure all of the specs repos use it. We would
have to land a small patch to trigger a rebuild, but the patch
switching them from oslosphinx to openstackdocstheme would serve
for that and a small change to the readme or another file would do it
for any that are already using the theme.
More information about the OpenStack-dev