On 19-Nov-20 11:24 AM, Bruce Richardson wrote:
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.bura...@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.richard...@intel.com>
Yes, we could, and i had that thought. I just decided to keep it simple
and not depending on FS layout. If there's consensus that picking it up
from FS is better approach, i can submit a v2.
--
Thanks,
Anatoly
