fix warnings, make sphinx fail on warnings

openml · PGijsbers · Apr 21, 2021 · Apr 7, 2021 · Apr 7, 2021 · Apr 7, 2021
commit 72491d51b5e98547bac8b42c96b8839e02c1588d
diff --git a/doc/conf.py b/doc/conf.py
@@ -344,3 +344,4 @@
 
 def setup(app):
     app.add_css_file("codehighlightstyle.css")
+    app.warningiserror = True
diff --git a/doc/usage.rst b/doc/usage.rst
@@ -16,9 +16,11 @@ This document will guide you through the most important use cases, functions
 and classes in the OpenML Python API. Throughout this document, we will use
 `pandas <http://pandas.pydata.org/>`_ to format and filter tables.
 
-~~~~~~~~~~~~~~~~~~~~~~
+.. _installation:
+
+~~~~~~~~~~~~~~~~~~~~~
 Installation & Set up
-~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 The OpenML Python package is a connector to `OpenML <https://www.openml.org/>`_.
 It allows you to use and share datasets and tasks, run

diff --git a/examples/30_extended/configure_logging.py b/examples/30_extended/configure_logging.py
@@ -6,8 +6,6 @@
 Explains openml-python logging, and shows how to configure it.
 """
 ##################################################################################
-# Logging
-# ^^^^^^^
 # Openml-python uses the `Python logging module <https://docs.python.org/3/library/logging.html>`_
 # to provide users with log messages. Each log message is assigned a level of importance, see
 # the table in Python's logging tutorial

diff --git a/examples/30_extended/custom_flow_.py b/examples/30_extended/custom_flow_.py
@@ -130,6 +130,7 @@
 # The exact format of the predictions will depend on the task.
 #
 # The predictions should always be a list of lists, each list should contain:
+#
 # - the repeat number: for repeated evaluation strategies. (e.g. repeated cross-validation)
 # - the fold number: for cross-validation. (what should this be for holdout?)
 # - 0: this field is for backward compatibility.

diff --git a/examples/30_extended/study_tutorial.py b/examples/30_extended/study_tutorial.py
@@ -25,6 +25,7 @@
 #   connects to the test server at test.openml.org before doing so.
 #   This prevents the crowding of the main server with example datasets,
 #   tasks, runs, and so on.
+#
 ############################################################################
 
 

diff --git a/examples/30_extended/suites_tutorial.py b/examples/30_extended/suites_tutorial.py
@@ -24,6 +24,7 @@
 #   connects to the test server at test.openml.org before doing so.
 #   This prevents the main server from crowding with example datasets,
 #   tasks, runs, and so on.
+#
 ############################################################################
Original file line number	Diff line number	Diff line change
Expand Up		@@ -344,3 +344,4 @@

		def setup(app):
		app.add_css_file("codehighlightstyle.css")
		app.warningiserror = True