update dtype api reference docs (#1745)

* update dtype api reference docs Signed-off-by: cosmicBboy <niels.bantilan@gmail.com> * update ci Signed-off-by: cosmicBboy <niels.bantilan@gmail.com> * update ci Signed-off-by: cosmicBboy <niels.bantilan@gmail.com> --------- Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>
unionai-oss · Jul 17, 2024 · b86978b · b86978b
1 parent 50949b0
commit b86978b
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 20 deletions.
diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
@@ -17,8 +17,6 @@ on:
 env:
  DEFAULT_PYTHON: 3.8
  CI: "true"
- # Increase this value to reset cache if environment.yml has not changed
- CACHE_VERSION: 6
 
 concurrency:
  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
@@ -140,9 +138,9 @@ jobs:
  ${{ runner.os }}-pip-
 
  - name: Install deps
- run:
+ run: |
  pip install uv
- uv pip install -r requirements.in
+ uv pip install --system -r requirements.in
 
  - run: |
  pip list

diff --git a/docs/source/_templates/class.rst b/docs/source/_templates/class.rst
@@ -31,7 +31,7 @@
  {% endif %}
 
  {%- if members and '__call__' in members %}
-  ~{{ name }}.__call__
+ .. automethod:: __call__
  {%- endif %}
 
  {% endblock %}
diff --git a/docs/source/_templates/dtype.rst b/docs/source/_templates/dtype.rst
@@ -22,19 +22,12 @@
  {% if methods %}
  .. rubric:: Methods
 
- .. autosummary::
- :nosignatures:
- :toctree: methods
-
- {# Ignore the DateTime alias to avoid `WARNING: document isn't included in any toctree`#}
- {% if objname != "DateTime" %}
- {% for item in methods %}
- ~{{ name }}.{{ item }}
- {%- endfor %}
+ {% for item in methods %}
+ .. automethod:: {{ item }}
+ {%- endfor %}
 
- {%- if members and '__call__' in members %}
- ~{{ name }}.__call__
- {%- endif %}
+ {%- if members and '__call__' in members %}
+ .. automethod:: __call__
  {%- endif %}
 
  {%- endif %}

diff --git a/docs/source/reference/core.rst b/docs/source/reference/core.rst
@@ -11,11 +11,11 @@ Schemas
  :template: class.rst
  :nosignatures:
 
- pandera.api.dataframe.container.DataFrameSchema
  pandera.api.pandas.container.DataFrameSchema
  pandera.api.pandas.array.SeriesSchema
  pandera.api.polars.container.DataFrameSchema
  pandera.api.pyspark.container.DataFrameSchema
+ pandera.api.dataframe.container.DataFrameSchema
 
 Schema Components
 -----------------
@@ -25,12 +25,12 @@ Schema Components
  :template: class.rst
  :nosignatures:
 
- pandera.api.dataframe.components.ComponentSchema
  pandera.api.pandas.components.Column
  pandera.api.pandas.components.Index
  pandera.api.pandas.components.MultiIndex
  pandera.api.polars.components.Column
  pandera.api.pyspark.components.Column
+ pandera.api.dataframe.components.ComponentSchema
 
 Checks
 ------

diff --git a/docs/source/reference/dataframe_models.rst b/docs/source/reference/dataframe_models.rst
@@ -13,6 +13,7 @@ DataFrame Model
  pandera.api.pandas.model.DataFrameModel
  pandera.api.polars.model.DataFrameModel
  pandera.api.pyspark.model.DataFrameModel
+ pandera.api.dataframe.model.DataFrameModel
 
 Model Components
 ----------------

diff --git a/docs/source/reference/dtypes.rst b/docs/source/reference/dtypes.rst
@@ -215,3 +215,5 @@ Engines
  pandera.engines.engine.Engine
  pandera.engines.numpy_engine.Engine
  pandera.engines.pandas_engine.Engine
+ pandera.engines.polars_engine.Engine
+ pandera.engines.pyspark_engine.Engine
diff --git a/pandera/api/dataframe/model.py b/pandera/api/dataframe/model.py
@@ -114,7 +114,7 @@ def _convert_extras_to_checks(extras: Dict[str, Any]) -> List[Check]:
 
 
 class DataFrameModel(Generic[TDataFrame, TSchema], BaseModel):
- """Definition of a generic DataFrame model.
+ """Base class for the DataFrame model.
 
  See the :ref:`User Guide <dataframe-models>` for more.
  """