Skip to content

Commit d953b88

Browse files
pquentingithub-actions[bot]
authored andcommitted
Fix simulate client docs (#2749)
* Fix simulate client docs * Fix formatting of Markdown code blocks * Fail on warnings when running `nox -s docs` too * Fix lint * Revert "Fix formatting of Markdown code blocks" This reverts commit 956175d. (cherry picked from commit b3e2f75)
1 parent 18bde03 commit d953b88

File tree

4 files changed

+7
-2
lines changed

4 files changed

+7
-2
lines changed

.readthedocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ python:
1717

1818
sphinx:
1919
configuration: docs/sphinx/conf.py
20+
fail_on_warning: true

docs/sphinx/api/simulate.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _snapshot-lifecycle-management:
1+
.. _simulate:
22

33
Simulate
44
--------

elasticsearch/client.py

+2
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
)
5858
from ._sync.client.security import SecurityClient as SecurityClient # noqa: F401
5959
from ._sync.client.shutdown import ShutdownClient as ShutdownClient # noqa: F401
60+
from ._sync.client.simulate import SimulateClient as SimulateClient # noqa: F401
6061
from ._sync.client.slm import SlmClient as SlmClient # noqa: F401
6162
from ._sync.client.snapshot import SnapshotClient as SnapshotClient # noqa: F401
6263
from ._sync.client.sql import SqlClient as SqlClient # noqa: F401
@@ -107,6 +108,7 @@
107108
"SearchableSnapshotsClient",
108109
"SecurityClient",
109110
"ShutdownClient",
111+
"SimulateClient",
110112
"SlmClient",
111113
"SnapshotClient",
112114
"SqlClient",

noxfile.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -127,4 +127,6 @@ def lint(session):
127127
@nox.session()
128128
def docs(session):
129129
session.install(".[docs]")
130-
session.run("sphinx-build", "docs/sphinx/", "docs/sphinx/_build", "-b", "html")
130+
session.run(
131+
"sphinx-build", "-W", "docs/sphinx/", "docs/sphinx/_build", "-b", "html"
132+
)

0 commit comments

Comments
 (0)