build: rename `sphinx_build.py` to `sphinx.py`
Change-Id: I3833075c0047dfe6ba51cbc6d17c55e0ad9069e6
diff --git a/.waf-tools/doxygen.py b/.waf-tools/doxygen.py
index 18b3292..6948194 100644
--- a/.waf-tools/doxygen.py
+++ b/.waf-tools/doxygen.py
@@ -24,9 +24,8 @@
bld(features="doxygen", doxyfile='Doxyfile', ...)
"""
-from fnmatch import fnmatchcase
-import os, os.path, re, stat
-from waflib import Task, Utils, Node, Logs, Errors, Build
+import os, os.path, re
+from waflib import Task, Utils, Node
from waflib.TaskGen import feature
DOXY_STR = '"${DOXYGEN}" - '
@@ -204,8 +203,8 @@
conf.find_program('doxygen', var='DOXYGEN', mandatory=False)
conf.find_program('tar', var='TAR', mandatory=False)
-# doxygen docs
+# doxygen command
from waflib.Build import BuildContext
class doxy(BuildContext):
- cmd = "doxygen"
- fun = "doxygen"
+ cmd = 'doxygen'
+ fun = 'doxygen'
diff --git a/.waf-tools/sphinx_build.py b/.waf-tools/sphinx.py
similarity index 92%
rename from .waf-tools/sphinx_build.py
rename to .waf-tools/sphinx.py
index 3666d5a..f538977 100644
--- a/.waf-tools/sphinx_build.py
+++ b/.waf-tools/sphinx.py
@@ -1,5 +1,7 @@
# inspired by code by Hans-Martin von Gaudecker, 2012
+"""Support for Sphinx documentation"""
+
import os
from waflib import Node, Task, TaskGen, Utils
@@ -34,8 +36,8 @@
node.sig=Utils.h_file(node.abspath())
-@TaskGen.feature("sphinx")
-@TaskGen.before_method("process_source")
+@TaskGen.feature('sphinx')
+@TaskGen.before_method('process_source')
def apply_sphinx(self):
"""Set up the task generator with a Sphinx instance and create a task."""
@@ -80,11 +82,12 @@
def configure(conf):
+ """Check if sphinx-build program is available."""
conf.find_program('sphinx-build', var='SPHINX_BUILD', mandatory=False)
-# sphinx docs
+# sphinx command
from waflib.Build import BuildContext
class sphinx(BuildContext):
- cmd = "sphinx"
- fun = "sphinx"
+ cmd = 'sphinx'
+ fun = 'sphinx'
diff --git a/wscript b/wscript
index 4fabe03..09363f1 100644
--- a/wscript
+++ b/wscript
@@ -13,7 +13,7 @@
opt.load(['cross', 'default-compiler-flags', 'pch',
'coverage', 'sanitizers', 'osx-frameworks',
'boost', 'openssl', 'sqlite3',
- 'doxygen', 'sphinx_build'],
+ 'doxygen', 'sphinx'],
tooldir=['.waf-tools'])
opt = opt.add_option_group('ndn-cxx Options')
@@ -79,7 +79,7 @@
conf.load(['compiler_cxx', 'gnu_dirs', 'c_osx',
'cross', 'default-compiler-flags', 'pch',
'osx-frameworks', 'boost', 'openssl', 'sqlite3',
- 'doxygen', 'sphinx_build'])
+ 'doxygen', 'sphinx'])
conf.env.WITH_EXAMPLES = conf.options.with_examples
conf.env.WITH_BENCHMARKS = conf.options.with_benchmarks or conf.options.with_tests