summaryrefslogtreecommitdiff
path: root/utils/check-sphinx/README
blob: acbf1afd455875684cca34fc7639a51c34264cdf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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.