diff options
Diffstat (limited to 'utils/check-sphinx/README')
| -rw-r--r-- | utils/check-sphinx/README | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/utils/check-sphinx/README b/utils/check-sphinx/README new file mode 100644 index 0000000000..acbf1afd45 --- /dev/null +++ b/utils/check-sphinx/README @@ -0,0 +1,17 @@ +This utility is intended to be used by $(TOP)/configure to check +sphinx's python version. + +We need python3-sphinx instead of python2-sphinx to build documentation, +such as GHC user's guide. +However, it can't be confirmed with the command line option of sphinx-build. +This utility performs a version check via conf.py invoked from sphinx-build. + +Usage: + + $SPHINXBUILD -b text . dist > /dev/null 2>&1 + echo $? + +If your python for sphinx is python2, it returns error status code 1. + + +See description in $(TOP)/configure.ac. |