Commit generated API docs (#824)

We need them to build RTD

Author: therve

.gitignore

@@ -1,7 +1,6 @@
 .env
 src/datadog_api_client/version.py
 .generator/lib
-docs/datadog_api_client*.rst
 examples/generated
 site
 

.pre-commit-config.yaml

@@ -20,6 +20,14 @@ repos:
       # When updating the version of prettier, make sure to check the  pre-commit file
       # And keep the `entry` here up to date https://github.com/pre-commit/mirrors-prettier/blob/master/.pre-commit-hooks.yaml
       - [email protected]
+  - id: api-docs
+    name: Generate API docs
+    stages: [manual]
+    language: python
+    entry: sphinx-apidoc --output-dir docs --force --no-toc src/datadog_api_client *apis *models *version.py
+    pass_filenames: false
+    additional_dependencies:
+      - Sphinx
   - id: openapi-generator
     name: OpenAPI-generator
     language: node

Makefile

@@ -9,6 +9,7 @@ all: .generator .env
 	@pre-commit run --all-files --hook-stage=manual docs || echo "modified files"
 	@pre-commit run --all-files --hook-stage=manual autoflake || echo "modified files"
 	@pre-commit run --all-files --hook-stage=manual black || echo "modified files"
+	@pre-commit run --all-files --hook-stage=manual api-docs || echo "modified files"
 
 .PHONY: .env
 .env:

docs/datadog_api_client.rst

@@ -0,0 +1,19 @@
+datadog\_api\_client package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   datadog_api_client.v1
+   datadog_api_client.v2
+
+Module contents
+---------------
+
+.. automodule:: datadog_api_client
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/datadog_api_client.v1.api.rst

@@ -0,0 +1,253 @@
+datadog\_api\_client.v1.api package
+===================================
+
+Submodules
+----------
+
+datadog\_api\_client.v1.api.authentication\_api module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.authentication_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.aws\_integration\_api module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.aws_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.aws\_logs\_integration\_api module
+--------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.aws_logs_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.azure\_integration\_api module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.azure_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.dashboard\_lists\_api module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.dashboard_lists_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.dashboards\_api module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.dashboards_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.downtimes\_api module
+-------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.downtimes_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.events\_api module
+----------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.events_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.gcp\_integration\_api module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.gcp_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.hosts\_api module
+---------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.hosts_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.ip\_ranges\_api module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.ip_ranges_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.key\_management\_api module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.key_management_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.logs\_api module
+--------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.logs_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.logs\_indexes\_api module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.logs_indexes_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.logs\_pipelines\_api module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.logs_pipelines_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.metrics\_api module
+-----------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.metrics_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.monitors\_api module
+------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.monitors_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.notebooks\_api module
+-------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.notebooks_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.organizations\_api module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.organizations_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.pager\_duty\_integration\_api module
+----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.pager_duty_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.service\_checks\_api module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.service_checks_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.service\_level\_objective\_corrections\_api module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.service_level_objective_corrections_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.service\_level\_objectives\_api module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.service_level_objectives_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.slack\_integration\_api module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.slack_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.snapshots\_api module
+-------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.snapshots_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.synthetics\_api module
+--------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.synthetics_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.tags\_api module
+--------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.tags_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.usage\_metering\_api module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.usage_metering_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.users\_api module
+---------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.users_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.api.webhooks\_integration\_api module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.api.webhooks_integration_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: datadog_api_client.v1.api
+   :members:
+   :undoc-members:
+   :show-inheritance: