[DOCS] Separate sub-client sections to standalone pages (#2375)

Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 5ac6428)
elastic · Nov 21, 2023 · 2ce5f95 · 2ce5f95
1 parent 742851e
commit 2ce5f95
Show file tree

Hide file tree

Showing 39 changed files with 373 additions and 230 deletions.
diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst
@@ -5,237 +5,50 @@ Elasticsearch API Reference
 
 All the API calls map the raw REST API as closely as possible, including the
 distinction between required and optional arguments to the calls. Keyword
-arguments are required for all 
+arguments are required for all calls.
 
 .. note::
 
    Some API parameters in Elasticsearch are reserved keywords in Python.
-   For example the ``from`` query parameter for pagination would be
-   aliased as ``from_``.
-
-
-Elasticsearch
--------------
-
-.. py:module:: elasticsearch
-
-.. autoclass:: Elasticsearch
-   :members:
-
-.. py:module:: elasticsearch.client
-
-Async Search
-------------
-
-.. autoclass:: AsyncSearchClient
-   :members:
-
-Autoscaling
------------
-
-.. autoclass:: AutoscalingClient
-   :members:
-
-Cat
----
-
-.. autoclass:: CatClient
-   :members:
-
-Cross-Cluster Replication (CCR)
--------------------------------
-
-.. autoclass:: CcrClient
-   :members:
-
-Cluster
--------
-
-.. autoclass:: ClusterClient
-   :members:
-
-Dangling Indices
-----------------
-
-.. autoclass:: DanglingIndicesClient
-   :members:
-
-Enrich Policies
----------------
-
-.. autoclass:: EnrichClient
-   :members:
-
-Event Query Language (EQL)
---------------------------
-
-.. autoclass:: EqlClient
-   :members:
-
-Snapshottable Features
-----------------------
-
-.. autoclass:: FeaturesClient
-   :members:
-
-Fleet
------
-
-.. autoclass:: FleetClient
-   :members:
-
-Graph Explore
--------------
-
-.. autoclass:: GraphClient
-   :members:
-
-Index Lifecycle Management (ILM)
---------------------------------
-
-.. autoclass:: IlmClient
-   :members:
-
-Indices
--------
-
-.. autoclass:: IndicesClient
-   :members:
-
-Ingest Pipelines
-----------------
-
-.. autoclass:: IngestClient
-   :members:
-
-License
--------
-
-.. autoclass:: LicenseClient
-   :members:
-
-Logstash
---------
-
-.. autoclass:: LogstashClient
-   :members:
-
-Migration
----------
-
-.. autoclass:: MigrationClient
-   :members:
-
-Machine Learning (ML)
----------------------
-
-.. autoclass:: MlClient
-   :members:
-
-Monitoring
-----------
-
-.. autoclass:: MonitoringClient
-   :members:
-
-Nodes
------
-
-.. autoclass:: NodesClient
-   :members:
-
-Query rules
------------
-
-.. autoclass:: QueryRulesetClient
-   :members:
-
-Rollup Indices
---------------
-
-.. autoclass:: RollupClient
-   :members:
-
-Search Applications
--------------------
-
-.. autoclass:: SearchApplicationClient
-   :members:
-
-Searchable Snapshots
---------------------
-
-.. autoclass:: SearchableSnapshotsClient
-   :members:
-
-Security
---------
-
-.. autoclass:: SecurityClient
-   :members:
-
-Shutdown
---------
-
-.. autoclass:: ShutdownClient
-   :members:
-
-Snapshot Lifecycle Management (SLM)
------------------------------------
-
-.. autoclass:: SlmClient
-   :members:
-
-Snapshots
----------
-
-.. autoclass:: SnapshotClient
-   :members:
-
-SQL
----
-
-.. autoclass:: SqlClient
-   :members:
-
-Synonyms
---------
-
-.. autoclass:: SynonymsClient
-   :members:
-
-TLS/SSL
--------
-
-.. autoclass:: SslClient
-   :members:
-
-Tasks
------
-
-.. autoclass:: TasksClient
-   :members:
-
-Text Structure
---------------
-
-.. autoclass:: TextStructureClient
-   :members:
-
-Transforms
-----------
-
-.. autoclass:: TransformClient
-   :members:
-
-Watcher
--------
-
-.. autoclass:: WatcherClient
-   :members:
-
-X-Pack
-------
-
-.. autoclass:: XPackClient
-   :members:
+   For example the ``from`` query parameter for pagination would be aliased as 
+   ``from_``.
+
+.. toctree::
+   :maxdepth: 1
+
+   api/elasticsearch
+   api/autoscaling
+   api/cat
+   api/ccr
+   api/cluster
+   api/dangling-indices
+   api/enrich-policies
+   api/eql
+   api/fleet
+   api/graph-explore
+   api/index-lifecycle-management
+   api/indices
+   api/ingest-pipelines
+   api/license
+   api/logstash
+   api/migration
+   api/ml
+   api/monitoring
+   api/nodes
+   api/query-rules
+   api/rollup-indices
+   api/search-application
+   api/searchable-snapshots
+   api/security
+   api/shutdown
+   api/snapshot-lifecycle-management
+   api/snapshots
+   api/snapshottable-features
+   api/sql
+   api/synonyms
+   api/tls-ssl
+   api/tasks
+   api/text-structure
+   api/transforms
+   api/watcher
+   api/x-pack
diff --git a/docs/sphinx/api/autoscaling.rst b/docs/sphinx/api/autoscaling.rst
@@ -0,0 +1,9 @@
+.. _autoscaling:
+
+Autoscaling
+-----------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: AutoscalingClient
+   :members:
diff --git a/docs/sphinx/api/cat.rst b/docs/sphinx/api/cat.rst
@@ -0,0 +1,9 @@
+.. _cat:
+
+Cat
+---
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: CatClient
+   :members:
diff --git a/docs/sphinx/api/ccr.rst b/docs/sphinx/api/ccr.rst
@@ -0,0 +1,9 @@
+.. _ccr:
+
+Cross-Cluster Replication (CCR)
+-------------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: CcrClient
+   :members:
diff --git a/docs/sphinx/api/cluster.rst b/docs/sphinx/api/cluster.rst
@@ -0,0 +1,9 @@
+.. _cluster:
+
+Cluster
+-------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: ClusterClient
+   :members:
diff --git a/docs/sphinx/api/dangling-indices.rst b/docs/sphinx/api/dangling-indices.rst
@@ -0,0 +1,9 @@
+.. _dangling-indices:
+
+Dangling Indices
+----------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: DanglingIndicesClient
+   :members:
diff --git a/docs/sphinx/api/elasticsearch.rst b/docs/sphinx/api/elasticsearch.rst
@@ -0,0 +1,11 @@
+.. _elasticsearch:
+
+Elasticsearch
+-------------
+
+.. py:module:: elasticsearch
+
+.. autoclass:: Elasticsearch
+   :members:
+
+.. py:module:: elasticsearch.client
diff --git a/docs/sphinx/api/enrich-policies.rst b/docs/sphinx/api/enrich-policies.rst
@@ -0,0 +1,9 @@
+.. _enrich-policies:
+
+Enrich Policies
+---------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: EnrichClient
+   :members:
diff --git a/docs/sphinx/api/eql.rst b/docs/sphinx/api/eql.rst
@@ -0,0 +1,9 @@
+.. _eql:
+
+Event Query Language (EQL)
+--------------------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: EqlClient
+   :members:
diff --git a/docs/sphinx/api/fleet.rst b/docs/sphinx/api/fleet.rst
@@ -0,0 +1,9 @@
+.. _fleet:
+
+Fleet
+-----
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: FleetClient
+   :members:
diff --git a/docs/sphinx/api/graph-explore.rst b/docs/sphinx/api/graph-explore.rst
@@ -0,0 +1,9 @@
+.. _graph-explore:
+
+Graph Explore
+-------------
+.. py:module:: elasticsearch.client
+   :noindex:
+
+.. autoclass:: GraphClient
+   :members: