Skip to content

Commit

Permalink
Merge pull request #62 from martindurant/akimbo_docs
Browse files Browse the repository at this point in the history
minimal changes to make docs build
  • Loading branch information
martindurant committed Jun 20, 2024
2 parents 83cbe37 + 7cfd615 commit 2575311
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 18 deletions.
9 changes: 2 additions & 7 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,15 @@ Top Level Functions
.. autosummary::
:toctree: generated/

from_awkward
merge
read_parquet
read_json

Accessor
~~~~~~~~

.. currentmodule:: akimbo.accessor
.. currentmodule:: akimbo.mixin

.. autosummary::
:toctree: generated/

AwkwardAccessor
AwkwardAccessor.array
AwkwardAccessor.to_column
AwkwardAccessor.to_columns
akimbo.mixin.Accessor
14 changes: 5 additions & 9 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Awkward Pandas
==============
Akimbo
======

The akimbo project provides a Pandas `ExtensionArray`_ and
`ExtensionDtype`_ that enable analysis of nested, non-tabular data in
workflows that are already leveraging `Pandas`_ Series and DataFrames.
The akimbo project provides a Dataframe accessor for various backend, that enable
analysis of nested, non-tabular data in
workflows

.. toctree::
:maxdepth: 1
Expand All @@ -22,7 +22,3 @@ workflows that are already leveraging `Pandas`_ Series and DataFrames.
:caption: API Reference

api.rst

.. _Pandas: https://pandas.pydata.org/
.. _ExtensionArray: https://pandas.pydata.org/docs/development/extending.html#extensionarray
.. _ExtensionDtype: https://pandas.pydata.org/docs/development/extending.html#extensiondtype
2 changes: 0 additions & 2 deletions src/akimbo/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
from __future__ import annotations

import akimbo.dask
import akimbo.pandas # noqa
from akimbo.io import read_json, read_parquet
from akimbo.version import version as __version__ # noqa

Expand Down

0 comments on commit 2575311

Please sign in to comment.