[PATCH 1/4] docs: Read version from 'patchwork.VERSION'

[Daniel Axtens]

Stephen Finucane <stephen at that.guru> writes:

> Because this isn't an installable package we need to do some path
> hackery. Not the end of the world though.
>
> Signed-off-by: Stephen Finucane <stephen at that.guru>
> ---
>  docs/conf.py | 15 +++++++++++----
>  1 file changed, 11 insertions(+), 4 deletions(-)
>
> diff --git a/docs/conf.py b/docs/conf.py
> index f692cf91..4fd3a04f 100644
> --- a/docs/conf.py
> +++ b/docs/conf.py
> @@ -2,12 +2,21 @@
>  #
>  # Patchwork documentation build configuration file
>  
> +import os
> +import sys
> +
>  try:
>      import sphinx_rtd_theme
>      has_rtd_theme = True
>  except ImportError:
>      has_rtd_theme = False
>  
> +PATCHWORK_DIR = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
> +sys.path.insert(0, PATCHWORK_DIR)
> +
> +from patchwork import VERSION  # noqa
I considered __version__, but I'm pretty sure VERSION is a better idea.

Series applied, thanks!

Regards,
Daniel


> +
> +
>  # -- General configuration ------------------------------------------------
>  
>  # If your documentation needs a minimal Sphinx version, state it here.
> @@ -45,12 +54,10 @@ author = u'Stephen Finucane'
>  # |version| and |release|, also used in various other places throughout the
>  # built documents.
>  #
> -# TODO(stephenfin): Eventually this should read the version programmatically
> -#
>  # The short X.Y version.
> -version = u'2.0-alpha'
> +version = '.'.join((str(x) for x in VERSION[:3]))
>  # The full version, including alpha/beta/rc tags.
> -release = u'2.0-alpha'
> +release = '.'.join((str(x) for x in VERSION))
>  
>  # The language for content autogenerated by Sphinx. Refer to documentation
>  # for a list of supported languages.
> -- 
> 2.14.3
>
> _______________________________________________
> Patchwork mailing list
> Patchwork at lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/patchwork