Skip to content

Commit

Permalink
update apidoc styling
Browse files Browse the repository at this point in the history
  • Loading branch information
@PedramNavid
PedramNavid committed Aug 9, 2024
1 parent b342c33 commit 2231e25
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 27 deletions.
1 change: 1 addition & 0 deletions docs/sphinx/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Celery + Docker (dagster-celery-docker)

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst", "range": {"start": {"line": 1, "column": 17}}}, "severity": "INFO"}

Check failure on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Dagster' instead of 'dagster'.

Raw Output:
{"message": "[Vale.Terms] Use 'Dagster' instead of 'dagster'.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst", "range": {"start": {"line": 1, "column": 18}}}, "severity": "ERROR"}

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.

Raw Output:
{"message": "[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-docker.rst", "range": {"start": {"line": 1, "column": 18}}}, "severity": "WARNING"}
--------------------------------
---------------------------------------


APIs
----
====

.. currentmodule:: dagster_celery_docker

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Celery + Kubernetes (dagster-celery-k8s)

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst", "range": {"start": {"line": 1, "column": 21}}}, "severity": "INFO"}

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.

Raw Output:
{"message": "[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst", "range": {"start": {"line": 1, "column": 22}}}, "severity": "WARNING"}

Check failure on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Dagster' instead of 'dagster'.

Raw Output:
{"message": "[Vale.Terms] Use 'Dagster' instead of 'dagster'.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-celery-k8s.rst", "range": {"start": {"line": 1, "column": 22}}}, "severity": "ERROR"}
------------------------------------
----------------------------------------

APIs
----
====

.. currentmodule:: dagster_celery_k8s

Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/sections/api/apidocs/libraries/dagster-databricks.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ access storage.
.. currentmodule:: dagster_databricks

APIs
----
====


Resources
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Orchestration on Docker
--------------------------------
Docker Orchestration (dagster-docker)

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst", "range": {"start": {"line": 1, "column": 22}}}, "severity": "INFO"}

Check failure on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Dagster' instead of 'dagster'.

Raw Output:
{"message": "[Vale.Terms] Use 'Dagster' instead of 'dagster'.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst", "range": {"start": {"line": 1, "column": 23}}}, "severity": "ERROR"}

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.

Raw Output:
{"message": "[Dagster.dagster_terms] Use 'Dagster' instead of 'dagster' when referring to a Dagster term.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagster-docker.rst", "range": {"start": {"line": 1, "column": 23}}}, "severity": "WARNING"}
-------------------------------------

APIs
----
====

.. currentmodule:: dagster_docker

Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pandas.rst
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
GCP + Pandas (dagster-gcp-pandas)
=================================
---------------------------------

.. currentmodule:: dagster_gcp_pandas

Google BigQuery
----------------
================
This library provides an integration with the `BigQuery <https://cloud.google.com/bigquery>`_ database and Pandas data processing library.

Related Guides:
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-gcp-pyspark.rst
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
GCP + PySpark (dagster-gcp-pyspark)
===================================
-----------------------------------

.. currentmodule:: dagster_gcp_pyspark

Google BigQuery
-----------------
================
This library provides an integration with the `BigQuery <https://cloud.google.com/bigquery>`_ database and PySpark data processing library.

Related Guides:
Expand Down
8 changes: 2 additions & 6 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-github.rst
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
.. role:: raw-html-m2r(raw)
:format: html


GitHub (dagster-github)
-----------------------

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/sphinx/sections/api/apidocs/libraries/dagster-k8s.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/sections/api/apidocs/libraries/dagster-pagerduty.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ code.
Presently, it provides a thin wrapper on the `Events API V2 <https://v2.developer.pagerduty.com/docs/events-api-v2>`_.

Getting Started
---------------
===============

You can install this library with:

Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-polars.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`):

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/sphinx/sections/api/apidocs/libraries/dagster-shell.rst
View file
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Dagstermill
Dagstermill (dagstermill)

Check warning on line 1 in docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/sphinx/sections/api/apidocs/libraries/dagstermill.rst", "range": {"start": {"line": 1, "column": 13}}}, "severity": "INFO"}
===========

This library provides an integration with `papermill` to allow you to run Jupyter notebooks with Dagster.
Expand Down

0 comments on commit 2231e25

Please sign in to comment.