DPDK patches and discussions
 help / color / Atom feed
* [dpdk-dev] [PATCH DPDK-KMODS] doc: allow external build
@ 2020-11-20 16:41 Anatoly Burakov
  2020-11-20 16:48 ` Burakov, Anatoly
  0 siblings, 1 reply; 2+ messages in thread
From: Anatoly Burakov @ 2020-11-20 16:41 UTC (permalink / raw)
  To: dev; +Cc: ferruh.yigit, thomas

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>
---
 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
 
 master_doc = 'index'
-- 
2.17.1

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [dpdk-dev] [PATCH DPDK-KMODS] doc: allow external build
  2020-11-20 16:41 [dpdk-dev] [PATCH DPDK-KMODS] doc: allow external build Anatoly Burakov
@ 2020-11-20 16:48 ` Burakov, Anatoly
  0 siblings, 0 replies; 2+ messages in thread
From: Burakov, Anatoly @ 2020-11-20 16:48 UTC (permalink / raw)
  To: dev; +Cc: ferruh.yigit, thomas

On 20-Nov-20 4:41 PM, 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>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> ---

Apologies, something went wrong with my automation...


-- 
Thanks,
Anatoly

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-20 16:41 [dpdk-dev] [PATCH DPDK-KMODS] doc: allow external build Anatoly Burakov
2020-11-20 16:48 ` Burakov, Anatoly

DPDK patches and discussions

Archives are clonable:
	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 \
		dev@dpdk.org
	public-inbox-index dev


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


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