DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: Anatoly Burakov <anatoly.burakov@intel.com>
Cc: dev@dpdk.org, thomas@monjalon.net
Subject: Re: [dpdk-dev] [PATCH] doc: allow sphinx build with no DPDK version
Date: Thu, 19 Nov 2020 11:24:31 +0000
Message-ID: <20201119112431.GA1829@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <027ca076ea8e2be6bd76987da23298ffd5db550f.1605782511.git.anatoly.burakov@intel.com>

On Thu, Nov 19, 2020 at 10:41:56AM +0000, Anatoly Burakov wrote:
> Currently, when building sphinx documentation, the build will only
> succeed if being run from the build system, because the conf.py script
> expects DPDK_VERSION environment variable to be set, and crashes if it
> is not.
> However, there are certain external tools (such as sphinx documentation
> preview extensions for certain IDE's) that use live preview and thus
> rely on running their own sphinx commands. In these cases, it is useful
> to permit building sphinx documentation without specifying the
> DPDK_VERSION environment variable. The version string is the only thing
> preventing manual sphinx build commands from working.
> Fix the conf.py to use "None" as a version string in cases when
> DPDK_VERSION environment variable is not set.
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
>  doc/guides/conf.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> diff --git a/doc/guides/conf.py b/doc/guides/conf.py
> index 9de490e1c4..aceeb62a4f 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -36,7 +36,7 @@
>  html_show_copyright = False
>  highlight_language = 'none'
> -release = environ['DPDK_VERSION']
> +release = environ.setdefault('DPDK_VERSION', "None")
>  version = release

Since this is python, we can probably pull the value from the VERSION file
on the FS if it's not specified in the environment. However, for now in
terms of solving this problem, this version is ok.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

  reply	other threads:[~2020-11-19 11:24 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-19 10:41 Anatoly Burakov
2020-11-19 11:24 ` Bruce Richardson [this message]
2020-11-19 11:44   ` Burakov, Anatoly
2020-11-19 11:48     ` Bruce Richardson
2020-11-19 12:03       ` Burakov, Anatoly
2020-11-19 12:22         ` Bruce Richardson
2020-11-19 14:11           ` Thomas Monjalon
2020-11-20  9:19 ` David Marchand

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201119112431.GA1829@bricha3-MOBL.ger.corp.intel.com \
    --to=bruce.richardson@intel.com \
    --cc=anatoly.burakov@intel.com \
    --cc=dev@dpdk.org \
    --cc=thomas@monjalon.net \


* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git