From 2231e25a170d17726ed11a2917a3abe327894104 Mon Sep 17 00:00:00 2001 From: Pedram Navid <1045990+PedramNavid@users.noreply.github.com> Date: Fri, 9 Aug 2024 15:51:03 -0700 Subject: [PATCH] update apidoc styling --- docs/sphinx/index.rst | 1 + .../api/apidocs/libraries/dagster-celery-docker.rst | 5 +++-- .../sections/api/apidocs/libraries/dagster-celery-k8s.rst | 4 ++-- .../sections/api/apidocs/libraries/dagster-databricks.rst | 2 +- .../sections/api/apidocs/libraries/dagster-docker.rst | 6 +++--- .../sections/api/apidocs/libraries/dagster-gcp-pandas.rst | 4 ++-- .../api/apidocs/libraries/dagster-gcp-pyspark.rst | 4 ++-- .../sections/api/apidocs/libraries/dagster-github.rst | 8 ++------ .../sphinx/sections/api/apidocs/libraries/dagster-k8s.rst | 3 ++- .../sections/api/apidocs/libraries/dagster-pagerduty.rst | 2 +- .../sections/api/apidocs/libraries/dagster-polars.rst | 8 ++++---- .../sections/api/apidocs/libraries/dagster-shell.rst | 4 ++-- .../sphinx/sections/api/apidocs/libraries/dagstermill.rst | 2 +- 13 files changed, 26 insertions(+), 27 deletions(-) diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst index 994046ff77513..cffd2ec4b9895 100644 --- a/docs/sphinx/index.rst +++ b/docs/sphinx/index.rst @@ -63,6 +63,7 @@ API Reference sections/api/apidocs/libraries/dagster-gcp-pyspark sections/api/apidocs/libraries/dagster-ge sections/api/apidocs/libraries/dagster-github + sections/api/apidocs/libraries/dagster-graphql sections/api/apidocs/libraries/dagster-k8s sections/api/apidocs/libraries/dagster-looker sections/api/apidocs/libraries/dagster-mlflow diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst index a29565d57895d..9138b6ae00142 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst @@ -1,8 +1,9 @@ Celery + Docker (dagster-celery-docker) --------------------------------- +--------------------------------------- + APIs ----- +==== .. currentmodule:: dagster_celery_docker diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst index bb85dee33b02e..2730a06cf752e 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst @@ -1,8 +1,8 @@ Celery + Kubernetes (dagster-celery-k8s) ------------------------------------- +---------------------------------------- APIs ----- +==== .. currentmodule:: dagster_celery_k8s diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-databricks.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-databricks.rst index 545d1791a22c0..39ca1465dbe70 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-databricks.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-databricks.rst @@ -18,7 +18,7 @@ access storage. .. currentmodule:: dagster_databricks APIs ----- +==== Resources diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst index 7ddd945580dd2..629b054bd97b1 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst @@ -1,8 +1,8 @@ -Orchestration on Docker --------------------------------- +Docker Orchestration (dagster-docker) +------------------------------------- APIs ----- +==== .. currentmodule:: dagster_docker diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pandas.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pandas.rst index fc36877970d8b..d3c7a804014cd 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pandas.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pandas.rst @@ -1,10 +1,10 @@ GCP + Pandas (dagster-gcp-pandas) -================================= +--------------------------------- .. currentmodule:: dagster_gcp_pandas Google BigQuery ----------------- +================ This library provides an integration with the `BigQuery `_ database and Pandas data processing library. Related Guides: diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pyspark.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pyspark.rst index 871161147ab74..99d84a1b45af7 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pyspark.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pyspark.rst @@ -1,10 +1,10 @@ GCP + PySpark (dagster-gcp-pyspark) -=================================== +----------------------------------- .. currentmodule:: dagster_gcp_pyspark Google BigQuery ------------------ +================ This library provides an integration with the `BigQuery `_ database and PySpark data processing library. Related Guides: diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-github.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-github.rst index 2e6f3778afe8d..d5c99428c38ca 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-github.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-github.rst @@ -1,7 +1,3 @@ -.. role:: raw-html-m2r(raw) - :format: html - - GitHub (dagster-github) ----------------------- @@ -39,7 +35,7 @@ Sharing your App ID and Installation ID is fine, but make sure that the Private stored securily. Posting Issues --------------- +============== Now, you can create issues in GitHub from Dagster with the GitHub resource: @@ -91,7 +87,7 @@ By provisioning ``GithubResource`` as a Dagster resource, you can post to GitHub within any asset or op execution. Executing GraphQL queries -------------------------- +======================== .. code-block:: python diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-k8s.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-k8s.rst index b3751ac2ee3b4..9118d1a2e0199 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-k8s.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-k8s.rst @@ -8,7 +8,8 @@ allowing the webserver to launch runs as Kubernetes Jobs, as well as a Helm char for a Dagster deployment on a Kubernetes cluster. APIs ----- +==== + .. currentmodule:: dagster_k8s .. autoconfigurable:: K8sRunLauncher diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-pagerduty.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-pagerduty.rst index 0162a308a258e..2be6ec76b133a 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-pagerduty.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-pagerduty.rst @@ -8,7 +8,7 @@ code. Presently, it provides a thin wrapper on the `Events API V2 `_. Getting Started ---------------- +=============== You can install this library with: diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-polars.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-polars.rst index 90a786d69a898..90ae1527a3101 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-polars.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-polars.rst @@ -11,7 +11,7 @@ Multiple serialization formats (Parquet, Delta Lake, BigQuery) and filesystems ( Comprehensive list of `dagster-polars` behavior for supported type annotations can be found in :ref:`Types` section. Installation ------------- +============ .. code-block:: pip install dagster-polars @@ -21,7 +21,7 @@ Some IOManagers (like :py:class:`PolarsDeltaIOManager`) may require additional d Please check the documentation for each IOManager for more details. Quickstart ----------- +========== Common filesystem-based IOManagers features highlights, using :py:class:`PolarsParquetIOManager` as an example (see :py:class:`BasePolarsUPathIOManager` for the full list of features provided by `dagster-polars`): @@ -103,7 +103,7 @@ This mode should be preferred for true partitioning. .. _Types: Type Annotations ----------------- +================ Type aliases like `DataFrameWithPartitions` are provided by :py:mod:`dagster_polars.types` for convenience. @@ -156,7 +156,7 @@ In the table below `StorageMetadata` expands to `Dict[str, Any]`. Generic builtins (like `tuple[...]` instead of `Tuple[...]`) are supported for Python >= 3.9. API Documentation ------------------ +================= .. autoconfigurable:: BasePolarsUPathIOManager :annotation: IOManagerDefinition diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagster-shell.rst b/docs/sphinx/sections/api/apidocs/libraries/dagster-shell.rst index 35faa6c18638b..4d962a0fa49e9 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagster-shell.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagster-shell.rst @@ -1,12 +1,12 @@ Shell (dagster-shell) ---------------------- +-------------------- The Dagster shell library provides utilities and op factories for executing inline shell scripts or script files. APIs ----- +==== .. currentmodule:: dagster_shell .. autofunction:: create_shell_command_op diff --git a/docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst b/docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst index ade92f85c5e15..52f80d33e74f2 100644 --- a/docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst +++ b/docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst @@ -1,4 +1,4 @@ -Dagstermill +Dagstermill (dagstermill) =========== This library provides an integration with `papermill` to allow you to run Jupyter notebooks with Dagster.