[openstack-dev] [docs] [pbr] [ptl] [oslo] Removing pbr's custom 'build_sphinx' setuptools command

Doug Hellmann doug at doughellmann.com
Mon Jul 10 17:55:13 UTC 2017

Excerpts from Anne Gentle's message of 2017-07-10 13:14:52 -0400:
> On Mon, Jul 10, 2017 at 1:11 PM, Doug Hellmann <doug at doughellmann.com> wrote:
> > Excerpts from sfinucan's message of 2017-07-10 17:20:37 +0100:
> >> On Fri, 2017-07-07 at 15:58 +0100, sfinucan at redhat.com wrote:
> >>
> >> Of these, 'project' is static and should never change, so we don't need to
> >> attempt to guess them. Version and release are dynamic but I've noticed we
> >> don't actually use them anywhere in openstackdocstheme (the version you see in
> >> the URL is actually an artefact of the build process and nothing to do with
> >> Sphinx). The closest thing we _do_ get to including version information is the
> >> commit ID include in header of api-ref build pages [1], which is generated by
> >> openstackdocstheme.
> >
> > It's surprising to me that we don't include the version string anywhere
> > on the page. Is that an oversight in the theme, or was it on purpose?
> The theme shows "current" - however I noticed while reviewing this
> morning the nomenclature is "latest" in the URL, so I will make a
> change. Do you suggest "latest -n.n.n" as the string value, or simply
> "latest"?

I thought we would want to insert the version, as reported in the
Sphinx config, without any reference to current or latest or the
release series.

Perhaps we can replace the static text "Project home page" in the left
sidebar with "{{project}} {{version}}" (with or without "home page")
like in https://review.openstack.org/482230 ?


More information about the OpenStack-dev mailing list