Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minimal changes to make docs build #62

Merged
merged 1 commit into from
Jun 20, 2024
Merged

minimal changes to make docs build #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions docs/api.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading