Building locally, with the latest kerl
, and KERL_BUILD_DOCS=yes
, I get
* documentation :
* ex_doc is missing.
* The documentation cannot be built.
Building docs...
Erlang/OTP 27.0-rc1 (27.0-rc1) has been successfully built
but I’m not asked about installing ex_doc
locally
In configure.ac
I do see
AC_CHECK_PROGS(EX_DOC, ex_doc)
if test -z "$EX_DOC"; then
EX_DOC="$ERL_TOP/make/ex_doc_wrapper"
echo "ex_doc" >> doc/CONF_INFO
AC_MSG_WARN([No 'ex_doc' command found: the documentation cannot be built])
fi
and ex_doc_wrapper
would eventually install ex_doc
but I don’t see it invoked
Later I tried to invoke . ./make/ex_doc_wrapper
directly, on macOS, but run into issues… for example read -p "Do you want to download latest ex_doc from github? (y/n)? " -n 1 -r
returns read: -p: no coprocess
…
@garazdawi, would it change your initial intentions much if you did
- read -p "Do you want to download latest ex_doc from github? (y/n)? " -n 1 -r
- echo
+ echo -n "Do you want to download latest ex_doc from github? (y/n)? "
+ read REPLY
and
- read -p "Press any key to continue..." -n 1 -r
+ echo "Press any key to continue..."
+ read
Later I also saw the documentation mentions
In order to build the documentation you need to have ex_doc
installed and available in your path. The simplest way to do that is to download
the escript for the latest release available on github.
so maybe the “wrapper” is not supposed to be invoked directly (as of now) and is just a helper. (?) Please let me know (link to kerl
issue. Update to allow generating documentation from OTP 27 on · Issue #509 · kerl/kerl · GitHub) if we can do something automatically, with kerl
, to ease building the documentation.