Fix Sphinx build errors (#2267)

Summary: See #2264 Pull Request resolved: #2267 Reviewed By: Balandat Differential Revision: D54833604 Pulled By: Cesar-Cardoso fbshipit-source-id: a2a2ca148ec4defaa1eb42e6d1cb10cd535a9e20
facebook · Mar 13, 2024 · aa9025e · aa9025e
1 parent 2081f6f
commit aa9025e
Show file tree

Hide file tree

Showing 16 changed files with 223 additions and 266 deletions.
diff --git a/ax/service/utils/with_db_settings_base.py b/ax/service/utils/with_db_settings_base.py
@@ -73,7 +73,7 @@
 
     # We retry on `OperationalError` if saving to DB.
     RETRY_EXCEPTION_TYPES = (OperationalError, StaleDataError)
-except (ModuleNotFoundError, IncompatibleDependencyVersion):
+except (ModuleNotFoundError, IncompatibleDependencyVersion, TypeError):
     DBSettings = None
     Decoder = None
     Encoder = None

diff --git a/sphinx/source/benchmark.rst b/sphinx/source/benchmark.rst
@@ -2,16 +2,16 @@
     :class: hidden-section
 
 ax.benchmark
-===================================
+============
 
 .. automodule:: ax.benchmark
 .. currentmodule:: ax.benchmark
 
 Benchmark
-----------------
+---------
 
 Benchmark Method
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.benchmark.benchmark_method
     :members:
@@ -28,7 +28,7 @@ Benchmark Problem
 
 
 Benchmark Result
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.benchmark.benchmark_result
     :members:
@@ -92,7 +92,7 @@ Benchmark Problems Surrogate
     :show-inheritance:
 
 Benchmark Problems Mixed Integer Synthetic
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.benchmark.problems.synthetic.discretized.mixed_integer
     :members:
@@ -108,15 +108,15 @@ Benchmark Problems Jenatton
     :show-inheritance:
 
 Benchmark Problems PyTorchCNN
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.benchmark.problems.hpo.pytorch_cnn
     :members:
     :undoc-members:
     :show-inheritance:
 
 Benchmark Problems PyTorchCNN TorchVision
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.benchmark.problems.hpo.torchvision
     :members:

diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py
@@ -78,7 +78,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -242,7 +242,7 @@
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"https://docs.python.org/": None}
+intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}
 
 # -- Autodocs Configuration -------------------------------------------
 
@@ -256,5 +256,7 @@
 autodoc_mock_imports = [
     "sqlalchemy",
     "pandas",
+    "plotly",
+    "tensorboard",
     "__test_modules__",
 ]
diff --git a/sphinx/source/core.rst b/sphinx/source/core.rst
@@ -2,26 +2,17 @@
     :class: hidden-section
 
 ax.core
-===================================
+=======
 
 .. automodule:: ax.core
 .. currentmodule:: ax.core
 
 
 Core Classes
--------------
-
-`AbstractData`
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: ax.core.abstract_data
-    :members:
-    :undoc-members:
-    :show-inheritance:
-    :noindex:
+------------
 
 `Arm`
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~
 
 .. automodule:: ax.core.arm
     :members:
@@ -37,15 +28,15 @@ Core Classes
     :show-inheritance:
 
 `BatchTrial`
-~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 .. automodule:: ax.core.batch_trial
     :members:
     :undoc-members:
     :show-inheritance:
 
 `Data`
-~~~~~~~~~~
+~~~~~~
 
 .. automodule:: ax.core.data
     :members:
@@ -54,15 +45,15 @@ Core Classes
     :noindex:
 
 `Experiment`
-~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 .. automodule:: ax.core.experiment
     :members:
     :undoc-members:
     :show-inheritance:
 
 `GenerationStrategyInterface`
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.core.generation_strategy_interface
     :members:
@@ -78,7 +69,7 @@ Core Classes
     :show-inheritance:
 
 `MapData`
-~~~~~~~~~~~~~~
+~~~~~~~~~
 
 .. automodule:: ax.core.map_data
     :members:
@@ -87,7 +78,7 @@ Core Classes
     :noindex:
 
 `MapMetric`
-~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 .. automodule:: ax.core.map_metric
     :members:
@@ -96,7 +87,7 @@ Core Classes
     :noindex:
 
 `Metric`
-~~~~~~~~~~~~~~
+~~~~~~~~
 
 .. automodule:: ax.core.metric
     :members:
@@ -113,7 +104,7 @@ Core Classes
     :show-inheritance:
 
 `Objective`
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 .. automodule:: ax.core.objective
     :members:
@@ -122,7 +113,7 @@ Core Classes
     :noindex:
 
 `Observation`
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 .. automodule:: ax.core.observation
     :members:
@@ -138,7 +129,7 @@ Core Classes
     :show-inheritance:
 
 `OutcomeConstraint`
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.core.outcome_constraint
     :members:
@@ -147,47 +138,47 @@ Core Classes
     :noindex:
 
 `Parameter`
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~
 
 .. automodule:: ax.core.parameter
     :members:
     :undoc-members:
     :show-inheritance:
 
 `ParameterConstraint`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.core.parameter_constraint
     :members:
     :undoc-members:
     :show-inheritance:
 
 `ParameterDistribution`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.core.parameter_distribution
     :members:
     :undoc-members:
     :show-inheritance:
 
 `RiskMeasure`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 .. automodule:: ax.core.risk_measures
     :members:
     :undoc-members:
     :show-inheritance:
 
 `Runner`
-~~~~~~~~~~~~~~~~
+~~~~~~~~
 
 .. automodule:: ax.core.runner
     :members:
     :undoc-members:
     :show-inheritance:
 
 `SearchSpace`
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 
 .. automodule:: ax.core.search_space
     :members:
@@ -196,7 +187,7 @@ Core Classes
     :noindex:
 
 `Trial`
-~~~~~~~~
+~~~~~~~
 
 .. automodule:: ax.core.trial
     :members:
@@ -222,7 +213,7 @@ Core Utils
     :show-inheritance:
 
 Formatting Utils
-----------
+----------------
 
 .. automodule:: ax.core.formatting_utils
     :members:

diff --git a/sphinx/source/early_stopping.rst b/sphinx/source/early_stopping.rst
@@ -2,7 +2,7 @@
     :class: hidden-section
 
 ax.early_stopping
-===================================
+=================
 
 .. automodule:: ax.early_stopping
 .. currentmodule:: ax.early_stopping

diff --git a/sphinx/source/exceptions.rst b/sphinx/source/exceptions.rst
@@ -2,14 +2,14 @@
     :class: hidden-section
 
 ax.exceptions
-===================================
+=============
 
 .. automodule:: ax.exceptions
 .. currentmodule:: ax.exceptions
 
 
 Constants
-~~~~~~~~~~~~~~~~~~
+~~~~~~~~~
 
 .. automodule:: ax.exceptions.constants
     :members:
@@ -18,39 +18,39 @@ Constants
 
 
 Core
-~~~~~~~~~~~~~~~~~~
+~~~~
 
 .. automodule:: ax.exceptions.core
     :members:
     :undoc-members:
     :show-inheritance:
 
 Data
-~~~~~~~~~~~~~~~~~~
+~~~~
 
 .. automodule:: ax.exceptions.data_provider
     :members:
     :undoc-members:
     :show-inheritance:
 
 Generation Strategy
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.exceptions.generation_strategy
     :members:
     :undoc-members:
     :show-inheritance:
 
 Model
-~~~~~~~~~~~~~~~~~~
+~~~~~
 
 .. automodule:: ax.exceptions.model
     :members:
     :undoc-members:
     :show-inheritance:
 
 Storage
-~~~~~~~~~~~~~~~~~~
+~~~~~~~
 
 .. automodule:: ax.exceptions.storage
     :members:

diff --git a/sphinx/source/global_stopping.rst b/sphinx/source/global_stopping.rst
@@ -2,7 +2,7 @@
     :class: hidden-section
 
 ax.global_stopping
-===================================
+==================
 
 .. automodule:: ax.global_stopping
 .. currentmodule:: ax.global_stopping
@@ -19,7 +19,7 @@ Base Strategies
     :show-inheritance:
 
 `ImprovementGlobalStoppingStrategy`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. automodule:: ax.global_stopping.strategies.improvement
     :members:

diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 API Reference
-===============================================
+=============
 
 .. toctree::
    :maxdepth: 2