improve sphinx api documenting

Author: chrishavlin

docs/conf.py

@@ -38,7 +38,7 @@
     "sphinx.ext.autosectionlabel",
     "nbsphinx",
 ]
-
+suppress_warnings = ["autosectionlabel.*"]
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -53,7 +53,7 @@
 
 # General information about the project.
 project = "yt_xarray"
-copyright = "2022, Chris Havlin"
+copyright = "2024, Chris Havlin"
 author = "Chris Havlin"
 
 # The version info for the project you're documenting, acts as replacement
@@ -70,7 +70,9 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
+
+toc_object_entries_show_parents = "hide"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/index.rst

@@ -18,12 +18,11 @@ If you come across any issues or have feature requests, please reach out at the
 
 .. toctree::
    :hidden:
-   :maxdepth: 2
 
    installation
    supported_grids
    examples
    faq
-   API <modules>
+   API <source/modules>
    contributing
 

docs/modules.rst

@@ -2,6 +2,9 @@ yt_xarray
 =========
 
 .. toctree::
-   :maxdepth: 4
 
-   yt_xarray
+   yt_xarray.open_dataset
+   yt_xarray.YtAccessor
+   yt_xarray.transformations
+   yt_xarray.sample_data
+

docs/source/modules.rst

@@ -0,0 +1,6 @@
+yt\_xarray.YtAccessor
+=====================
+
+.. autoclass:: yt_xarray.YtAccessor
+   :members:
+   :show-inheritance:

docs/source/yt_xarray.YtAccessor.rst

@@ -0,0 +1,4 @@
+yt\_xarray.open_dataset
+=======================
+
+.. autofunction:: yt_xarray.open_dataset

docs/source/yt_xarray.accessor.rst

@@ -0,0 +1,6 @@
+yt\_xarray.sample_data
+======================
+
+.. automodule:: yt_xarray.sample_data
+   :members:
+   :show-inheritance:

docs/source/yt_xarray.open_dataset.rst

@@ -0,0 +1,6 @@
+yt\_xarray.transformations
+==========================
+
+.. automodule:: yt_xarray.transformations
+   :members:
+   :show-inheritance: