Fix simulate client docs (#2749) (#2752)

elastic · Jan 20, 2025 · b139828 · b139828
1 parent bc44f1a
commit b139828
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -17,3 +17,4 @@ python:
 
 sphinx:
   configuration: docs/sphinx/conf.py
+  fail_on_warning: true
diff --git a/docs/sphinx/api/simulate.rst b/docs/sphinx/api/simulate.rst
@@ -1,4 +1,4 @@
-.. _snapshot-lifecycle-management:
+.. _simulate:
 
 Simulate
 --------

diff --git a/elasticsearch/client.py b/elasticsearch/client.py
@@ -57,6 +57,7 @@
 )
 from ._sync.client.security import SecurityClient as SecurityClient  # noqa: F401
 from ._sync.client.shutdown import ShutdownClient as ShutdownClient  # noqa: F401
+from ._sync.client.simulate import SimulateClient as SimulateClient  # noqa: F401
 from ._sync.client.slm import SlmClient as SlmClient  # noqa: F401
 from ._sync.client.snapshot import SnapshotClient as SnapshotClient  # noqa: F401
 from ._sync.client.sql import SqlClient as SqlClient  # noqa: F401
@@ -107,6 +108,7 @@
     "SearchableSnapshotsClient",
     "SecurityClient",
     "ShutdownClient",
+    "SimulateClient",
     "SlmClient",
     "SnapshotClient",
     "SqlClient",

diff --git a/noxfile.py b/noxfile.py
@@ -127,4 +127,6 @@ def lint(session):
 @nox.session()
 def docs(session):
     session.install(".[docs]")
-    session.run("sphinx-build", "docs/sphinx/", "docs/sphinx/_build", "-b", "html")
+    session.run(
+        "sphinx-build", "-W", "docs/sphinx/", "docs/sphinx/_build", "-b", "html"
+    )
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,3 +17,4 @@ python:

		sphinx:
		configuration: docs/sphinx/conf.py
		fail_on_warning: true