use sphinx-design directives instead of sphinx-panels (flyteorg#2364)

* update docs to use sphinx design, custom rst template Signed-off-by: cosmicBboy <[email protected]> * fix docstring formatting Signed-off-by: cosmicBboy <[email protected]> * update autosummary for accelerators Signed-off-by: cosmicBboy <[email protected]> --------- Signed-off-by: cosmicBboy <[email protected]>
jasonlai1218 · Apr 21, 2024 · 9d94c83 · 9d94c83
1 parent f116831
commit 9d94c83
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 6 deletions.
diff --git a/docs/source/extras.accelerators.rst b/docs/source/extras.accelerators.rst
@@ -1,4 +1,4 @@
 .. automodule:: flytekit.extras.accelerators
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/flytekit/configuration/__init__.py b/flytekit/configuration/__init__.py
@@ -35,7 +35,7 @@
 ``~/.flyte/config.yaml`` file, and  ``flytectl --help`` to learn about all of the configuration yaml options.
 
 .. dropdown:: See example ``config.yaml`` file
-   :title: text-muted
+   :color: muted
    :animate: fade-in-slide-down
 
    .. literalinclude:: ../../tests/flytekit/unit/configuration/configs/sample.yaml
@@ -49,7 +49,7 @@
 2. A file in ``~/.flyte/config`` in the home directory as detected by Python.
 
 .. dropdown:: See example ``flytekit.config`` file
-   :title: text-muted
+   :color: muted
    :animate: fade-in-slide-down
 
    .. literalinclude:: ../../tests/flytekit/unit/configuration/configs/images.config

diff --git a/flytekit/core/base_task.py b/flytekit/core/base_task.py
@@ -6,6 +6,8 @@
 .. currentmodule:: flytekit.core.base_task
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    kwtypes

diff --git a/flytekit/core/promise.py b/flytekit/core/promise.py
@@ -390,7 +390,9 @@ def with_var(self, new_var: str) -> Promise:
     def is_ready(self) -> bool:
         """
         Returns if the Promise is READY (is not a reference and the val is actually ready)
-        Usage:
+
+        Usage ::
+
            p = Promise(...)
            ...
            if p.is_ready():

diff --git a/flytekit/core/python_function_task.py b/flytekit/core/python_function_task.py
@@ -6,6 +6,8 @@
 .. currentmodule:: flytekit.core.python_function_task
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    PythonFunctionTask

diff --git a/flytekit/core/type_engine.py b/flytekit/core/type_engine.py
@@ -957,6 +957,7 @@ def get_transformer(cls, python_type: Type) -> TypeTransformer[T]:
 
           d = dictionary of registered transformers, where is a python `type`
           v = lookup type
+
         Step 1:
             If the type is annotated with a TypeTransformer instance, use that.
 

diff --git a/flytekit/deck/__init__.py b/flytekit/deck/__init__.py
@@ -8,6 +8,8 @@
 Contains deck renderers provided by flytekit.
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    Deck

diff --git a/flytekit/extend/__init__.py b/flytekit/extend/__init__.py
@@ -8,6 +8,8 @@
 This package contains things that are useful when extending Flytekit.
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    get_serializable

diff --git a/flytekit/extras/accelerators.py b/flytekit/extras/accelerators.py
@@ -31,6 +31,9 @@ def my_task() -> None:
 .. currentmodule:: flytekit.extras.accelerators
 
 .. autosummary::
+   :template: custom.rst
+   :toctree: generated/
+   :nosignatures:
 
    BaseAccelerator
    GPUAccelerator
@@ -75,6 +78,8 @@ def my_task() -> None:
 .. currentmodule:: flytekit.extras.accelerators
 
 .. autosummary::
+   :toctree: generated/
+   :nosignatures:
 
    A10G
    L4

diff --git a/flytekit/image_spec/__init__.py b/flytekit/image_spec/__init__.py
@@ -8,6 +8,8 @@
 This module contains the ImageSpec class parameters and methods.
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    ImageSpec

diff --git a/flytekit/testing/__init__.py b/flytekit/testing/__init__.py
@@ -9,6 +9,7 @@
 testing workflows that contain tasks that cannot run locally (a Hive task for instance).
 
 .. autosummary::
+   :template: custom.rst
    :toctree: generated/
 
    patch - A decorator similar to the regular one you're probably used to

diff --git a/flytekit/types/error/__init__.py b/flytekit/types/error/__init__.py
@@ -4,6 +4,8 @@
 .. currentmodule:: flytekit.types.error
 
 .. autosummary::
+   :nosignatures:
+   :template: custom.rst
    :toctree: generated/
 
    FlyteError

diff --git a/flytekit/types/iterator/__init__.py b/flytekit/types/iterator/__init__.py
@@ -2,8 +2,11 @@
 Flytekit Iterator Type
 ==========================================================
 .. currentmodule:: flytekit.types.iterator
+
 .. autosummary::
+   :nosignatures:
    :toctree: generated/
+
    FlyteIterator
 """
 

diff --git a/flytekit/types/pickle/__init__.py b/flytekit/types/pickle/__init__.py
@@ -4,6 +4,7 @@
 .. currentmodule:: flytekit.types.pickle
 
 .. autosummary::
+   :template: custom.rst
    :toctree: generated/
 
    FlytePickle
-Original file line number
+Diff line change
@@ Expand Up @@
               d = dictionary of registered transformers, where is a python `type`
               v = lookup type
             Step 1:
                 If the type is annotated with a TypeTransformer instance, use that.
@@ Expand Down @@