updates to allow building python docs again, also added checks for requirements to build the python docs

This commit is contained in:
Blake Harnden 2020-04-16 11:32:50 -07:00
parent 78d442b574
commit 5dcf2f45c5
4 changed files with 13 additions and 19 deletions

View file

@ -43,6 +43,11 @@ AC_ARG_ENABLE([gui],
[build and install the GUI (default is yes)])], [build and install the GUI (default is yes)])],
[], [enable_gui=yes]) [], [enable_gui=yes])
AC_SUBST(enable_gui) AC_SUBST(enable_gui)
AC_ARG_ENABLE([docs],
[AS_HELP_STRING([--enable-docs[=ARG]],
[build python documentation (default is no)])],
[], [enable_docs=no])
AC_SUBST(enable_docs)
AC_ARG_ENABLE([python], AC_ARG_ENABLE([python],
[AS_HELP_STRING([--enable-python[=ARG]], [AS_HELP_STRING([--enable-python[=ARG]],
@ -191,8 +196,7 @@ if [ test "x$enable_daemon" = "xyes" || test "x$enable_vnodedonly" = "xyes" ] ;
fi fi
want_docs=no want_docs=no
if test "x$enable_docs" = "xyes" ; then if [test "x$want_python" = "xyes" && test "x$enable_docs" = "xyes"] ; then
AC_CHECK_PROG(help2man, help2man, yes, no, $SEARCHPATH) AC_CHECK_PROG(help2man, help2man, yes, no, $SEARCHPATH)
if test "x$help2man" = "xno" ; then if test "x$help2man" = "xno" ; then
@ -210,21 +214,12 @@ if test "x$enable_docs" = "xyes" ; then
# check for sphinx required during make # check for sphinx required during make
AC_CHECK_PROG(sphinxapi_path, sphinx-apidoc, $as_dir, no, $SEARCHPATH) AC_CHECK_PROG(sphinxapi_path, sphinx-apidoc, $as_dir, no, $SEARCHPATH)
if test "x$sphinxapi_path" = "xno" ; then if test "x$sphinxapi_path" = "xno" ; then
AC_MSG_ERROR(["Could not location sphinx-apidoc, from the python-sphinx package"]) AC_MSG_ERROR(["Could not locate sphinx-apidoc, install python3 -m pip install sphinx"])
want_docs=no want_docs=no
fi fi
AS_IF([$PYTHON -c "import sphinx_rtd_theme" &> /dev/null], [], [AC_MSG_ERROR([doc dependency missing, please install python3 -m pip install sphinx-rtd-theme])])
fi fi
#AC_PATH_PROGS(tcl_path, [tclsh tclsh8.5 tclsh8.4], no)
#if test "x$tcl_path" = "xno" ; then
# AC_MSG_ERROR([Could not locate tclsh. Please install Tcl/Tk.])
#fi
#AC_PATH_PROGS(wish_path, [wish wish8.5 wish8.4], no)
#if test "x$wish_path" = "xno" ; then
# AC_MSG_ERROR([Could not locate wish. Please install Tcl/Tk.])
#fi
AC_ARG_WITH([startup], AC_ARG_WITH([startup],
[AS_HELP_STRING([--with-startup=option], [AS_HELP_STRING([--with-startup=option],
[option=systemd,suse,none to install systemd/SUSE init scripts])], [option=systemd,suse,none to install systemd/SUSE init scripts])],

View file

@ -1031,8 +1031,7 @@ class CoreGrpcServer(core_pb2_grpc.CoreApiServicer):
""" """
Retrieve all the default services of all node types in a session Retrieve all the default services of all node types in a session
:param request: :param request: get-default-service request
get-default-service request
:param context: context object :param context: context object
:return: get-service-defaults response about all the available default services :return: get-service-defaults response about all the available default services
""" """
@ -1050,8 +1049,8 @@ class CoreGrpcServer(core_pb2_grpc.CoreApiServicer):
) -> SetServiceDefaultsResponse: ) -> SetServiceDefaultsResponse:
""" """
Set new default services to the session after whipping out the old ones Set new default services to the session after whipping out the old ones
:param request: set-service-defaults
request :param request: set-service-defaults request
:param context: context object :param context: context object
:return: set-service-defaults response :return: set-service-defaults response
""" """

View file

@ -10,7 +10,7 @@
# extra cruft to remove # extra cruft to remove
DISTCLEANFILES = conf.py Makefile Makefile.in stamp-vti *.rst DISTCLEANFILES = conf.py Makefile Makefile.in stamp-vti *.rst
all: index.rst all: html
# auto-generated Python documentation using Sphinx # auto-generated Python documentation using Sphinx
index.rst: index.rst:

View file

@ -121,7 +121,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] #html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format. # using the given strftime format.