From: David Marchand <david.marchand@redhat.com>
To: Anatoly Burakov <anatoly.burakov@intel.com>
Cc: dev <dev@dpdk.org>, Thomas Monjalon <thomas@monjalon.net>,
Bruce Richardson <bruce.richardson@intel.com>
Subject: Re: [dpdk-dev] [PATCH] doc: allow sphinx build with no DPDK version
Date: Fri, 20 Nov 2020 10:19:51 +0100 [thread overview]
Message-ID: <CAJFAV8wk1Sr_DRMwVKQkukGZwNWwZU8jVPUud6yk3m1VrmTvBQ@mail.gmail.com> (raw)
In-Reply-To: <027ca076ea8e2be6bd76987da23298ffd5db550f.1605782511.git.anatoly.burakov@intel.com>
On Thu, Nov 19, 2020 at 11:42 AM Anatoly Burakov
<anatoly.burakov@intel.com> 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>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
So now, no excuse for documentation patches that fail to build :-).
Applied, thanks.
--
David Marchand
prev parent reply other threads:[~2020-11-20 9:20 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
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 [this message]
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:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAJFAV8wk1Sr_DRMwVKQkukGZwNWwZU8jVPUud6yk3m1VrmTvBQ@mail.gmail.com \
--to=david.marchand@redhat.com \
--cc=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).