doc: allow external build
authorAnatoly Burakov <anatoly.burakov@intel.com>
Thu, 19 Nov 2020 10:41:56 +0000 (10:41 +0000)
committerDavid Marchand <david.marchand@redhat.com>
Fri, 20 Nov 2020 09:18:09 +0000 (10:18 +0100)
commit7bda955f729dd450e5cd63e93962df37de4ee91b
tree17f2930bcae099f35820649dcb5ee3f92a66cd24
parentb23fd370cd5b84228d453e52931eaa5cd3f2846c
doc: allow external build

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