Skip to content

Commit

Permalink
fix: Remove empty python bindings documentation
Browse files Browse the repository at this point in the history
The python bindings documentation doesn't exist yet but the build system
contains remnants of the bt1 doc. Moreover, it contains a Sphinx theme
without any copyright or licensing information which makes our distro
friends a bit nervous.

Remove everything for now, it can be re-introduced when the doc is
actually written.

Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Change-Id: I11b23822c8bf98c54a88c7e856d606d01102797f
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2941
Reviewed-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  • Loading branch information
mjeanson authored and jgalar committed Feb 3, 2020
1 parent f1f3b04 commit e3757f6
Show file tree
Hide file tree
Showing 40 changed files with 1 addition and 2,978 deletions.
6 changes: 0 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,6 @@ _**If you need the https://lttng.org/[LTTng] debug information filter component
(Debian/Ubuntu: `libelf-dev` and `libdw-dev`;
Fedora: `elfutils-devel` and `elfutils-libelf-devel`)

_**If you need the `bt2` Python bindings documentation**_::
* Python{nbsp}≥{nbsp}3.4
(Debian/Ubuntu/Fedora: `python3`)
* https://www.sphinx-doc.org/en/master/[Sphinx]{nbsp}≥{nbsp}1.6.5
for Python{nbsp}3 (Debian/Ubuntu/Fedora: `python3-sphinx`)

_**If you need the {bt2}{nbsp}C{nbsp}API HTML documentation**_::
* http://www.doxygen.nl/[Doxygen]{nbsp}≥{nbsp}1.8.6

Expand Down
28 changes: 0 additions & 28 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -366,14 +366,6 @@ AC_ARG_ENABLE([python-bindings],
[enable_python_bindings=no]
)

# Python bindings documentation
# Disabled by default
AC_ARG_ENABLE([python-bindings-doc],
[AC_HELP_STRING([--enable-python-bindings-doc], [build the Python bindings documentation])],
[], dnl AC_ARG_ENABLE will fill enable_python_bindings_doc with the user choice
[enable_python_bindings_doc=no]
)

# Python plugins
# Disabled by default
AC_ARG_ENABLE([python-plugins],
Expand Down Expand Up @@ -425,7 +417,6 @@ AC_ARG_ENABLE([man-pages],

# Set automake variables for optionnal feature conditionnals in Makefile.am
AM_CONDITIONAL([ENABLE_PYTHON_BINDINGS], [test "x$enable_python_bindings" = xyes])
AM_CONDITIONAL([ENABLE_PYTHON_BINDINGS_DOC], [test "x$enable_python_bindings_doc" = xyes])
AM_CONDITIONAL([ENABLE_PYTHON_PLUGINS], [test "x$enable_python_plugins" = xyes])
AM_CONDITIONAL([ENABLE_DEBUG_INFO], [test "x$enable_debug_info" = xyes])
AM_CONDITIONAL([ENABLE_API_DOC], [test "x$enable_api_doc" = xyes])
Expand Down Expand Up @@ -463,12 +454,6 @@ AC_SUBST([ENABLE_DEBUG_INFO_VAL])

# Check for conflicting optional features user choices

AS_IF([test "x$enable_python_bindings" = xno],
[
AS_IF([test "x$enable_python_bindings_doc" = xyes], [AC_MSG_ERROR([--enable-python-bindings-doc was specified without --enable-python-bindings])])
]
)

AS_IF([test "x$enable_built_in_plugins" = xyes],
[
# Built-in plug-ins are only available when the --disable-shared --enable-static options are used.
Expand Down Expand Up @@ -539,15 +524,6 @@ AS_IF([test "x$enable_python_bindings" = xyes || test "x$enable_python_plugins"
])
])

AS_IF([test "x$enable_python_bindings_doc" = xyes],
[
AM_CHECK_PYTHON_SPHINX([PYTHON])
AS_IF([test "x$PYTHON_SPHINX_EXISTS" = xno],
[AC_MSG_ERROR([The Sphinx package for Python 3 is required to build the Python bindings documentation])]
)
]
)

AS_IF([test "x$enable_debug_info" = xyes],
[
# Check if libelf and libdw are present
Expand Down Expand Up @@ -735,8 +711,6 @@ AC_CONFIG_FILES([
doc/api/Makefile
doc/api/libbabeltrace2/Doxyfile
doc/api/libbabeltrace2/Makefile
doc/bindings/Makefile
doc/bindings/python/Makefile
doc/contributing-images/Makefile
doc/Makefile
doc/man/asciidoc-attrs.conf
Expand Down Expand Up @@ -922,8 +896,6 @@ m4_popdef([build_man_pages_msg])

test "x$enable_api_doc" = "xyes" && value=1 || value=0
PPRINT_PROP_BOOL([HTML API documentation], $value)
test "x$enable_python_bindings_doc" = "xyes" && value=1 || value=0
PPRINT_PROP_BOOL([Python bindings documentation], $value)

AS_ECHO
PPRINT_SUBTITLE([Logging])
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SUBDIRS = bindings contributing-images man
SUBDIRS = contributing-images man

if ENABLE_API_DOC
SUBDIRS += api
Expand Down
3 changes: 0 additions & 3 deletions doc/bindings/Makefile.am

This file was deleted.

3 changes: 0 additions & 3 deletions doc/bindings/python/.gitignore

This file was deleted.

29 changes: 0 additions & 29 deletions doc/bindings/python/Makefile.am

This file was deleted.

Empty file.
15 changes: 0 additions & 15 deletions doc/bindings/python/source/_themes/sphinx_rtd_theme/__init__.py

This file was deleted.

This file was deleted.

52 changes: 0 additions & 52 deletions doc/bindings/python/source/_themes/sphinx_rtd_theme/footer.html

This file was deleted.

Loading

0 comments on commit e3757f6

Please sign in to comment.