Skip to content

Fix simulate client docs #2749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 20, 2025
Merged

Fix simulate client docs #2749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d379424
Fix simulate client docs
pquentin Jan 17, 2025
956175d
Fix formatting of Markdown code blocks
pquentin Jan 17, 2025
84e3b5a
Fail on warnings when running `nox -s docs` too
pquentin Jan 17, 2025
24e7f33
Fix lint
pquentin Jan 17, 2025
4f22c26
Revert "Fix formatting of Markdown code blocks"
pquentin Jan 17, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yml
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion docs/sphinx/api/simulate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _snapshot-lifecycle-management:
.. _simulate:

Simulate
--------
Expand Down
2 changes: 2 additions & 0 deletions elasticsearch/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -107,6 +108,7 @@
"SearchableSnapshotsClient",
"SecurityClient",
"ShutdownClient",
"SimulateClient",
"SlmClient",
"SnapshotClient",
"SqlClient",
Expand Down
4 changes: 3 additions & 1 deletion noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Loading