From 5fd1221815ef0a9aae17200d506163b3b103c6b4 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Thu, 15 Jun 2023 10:50:19 -0500 Subject: [PATCH] Fix autosummary directive by removing hack autosummaries --- docs/sphinx/conf.py | 1 + docs/sphinx/reference/api/eland.DataFrame.rst | 12 ------------ .../reference/api/eland.groupby.DataFrameGroupBy.rst | 9 --------- docs/sphinx/reference/api/eland.groupby.GroupBy.rst | 9 --------- docs/sphinx/reference/api/eland.ml.MLModel.rst | 9 --------- 5 files changed, 1 insertion(+), 39 deletions(-) diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index cc261d2..6c14584 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -58,6 +58,7 @@ release = version # ones. extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.autosummary", "sphinx.ext.doctest", "sphinx.ext.extlinks", "matplotlib.sphinxext.plot_directive", diff --git a/docs/sphinx/reference/api/eland.DataFrame.rst b/docs/sphinx/reference/api/eland.DataFrame.rst index 8929d81..f54dc79 100644 --- a/docs/sphinx/reference/api/eland.DataFrame.rst +++ b/docs/sphinx/reference/api/eland.DataFrame.rst @@ -4,15 +4,3 @@ eland.DataFrame .. currentmodule:: eland .. autoclass:: DataFrame - - - - -.. - HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. - .. autosummary:: - :toctree: - - DataFrame.abs - DataFrame.add - diff --git a/docs/sphinx/reference/api/eland.groupby.DataFrameGroupBy.rst b/docs/sphinx/reference/api/eland.groupby.DataFrameGroupBy.rst index 858c005..de1202d 100644 --- a/docs/sphinx/reference/api/eland.groupby.DataFrameGroupBy.rst +++ b/docs/sphinx/reference/api/eland.groupby.DataFrameGroupBy.rst @@ -4,12 +4,3 @@ eland.groupby.DataFrameGroupBy .. currentmodule:: eland.groupby .. autoclass:: DataFrameGroupBy - - -.. - HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. - .. autosummary:: - :toctree: - - DataFrame.abs - DataFrame.add diff --git a/docs/sphinx/reference/api/eland.groupby.GroupBy.rst b/docs/sphinx/reference/api/eland.groupby.GroupBy.rst index fc9872e..acab8db 100644 --- a/docs/sphinx/reference/api/eland.groupby.GroupBy.rst +++ b/docs/sphinx/reference/api/eland.groupby.GroupBy.rst @@ -4,12 +4,3 @@ eland.groupby.GroupBy .. currentmodule:: eland.groupby .. autoclass:: GroupBy - - -.. - HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. - .. autosummary:: - :toctree: - - DataFrame.abs - DataFrame.add diff --git a/docs/sphinx/reference/api/eland.ml.MLModel.rst b/docs/sphinx/reference/api/eland.ml.MLModel.rst index c936c84..83c7618 100644 --- a/docs/sphinx/reference/api/eland.ml.MLModel.rst +++ b/docs/sphinx/reference/api/eland.ml.MLModel.rst @@ -4,12 +4,3 @@ eland.ml.MLModel .. currentmodule:: eland.ml .. autoclass:: MLModel - - -.. - HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. - .. autosummary:: - :toctree: - - DataFrame.abs - DataFrame.add