Fix docs

Author: znicholls

docs/changelog.md

@@ -25,8 +25,8 @@ from the examples given in that link.
 
 ### 🆕 Features
 
-- - Added unit conversion APIs: [pandas_openscm.unit_conversion.convert_unit] and [pandas_openscm.unit_conversion.convert_unit_like] and the corresponding accessors [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.convert_unit] and [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.convert_unit_like]
-  - Added the helper: [pandas_openscm.index_manipulation.ensure_is_multiindex] and the corresponding accessors [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.ensure_index_is_multiindex] and [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.eiim]
+- - Added unit conversion APIs: [pandas_openscm.unit_conversion.convert_unit] and [pandas_openscm.unit_conversion.convert_unit_like] and the corresponding accessors [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.convert_unit] and [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.convert_unit_like]
+  - Added the helper: [pandas_openscm.index_manipulation.ensure_is_multiindex] and the corresponding accessors [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.ensure_index_is_multiindex] and [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.eiim]
 
   ([#23](https://github.com/openscm/pandas-openscm/pull/23))
 
@@ -46,7 +46,7 @@ from the examples given in that link.
 
 ### 🆕 Features
 
-- Added [pandas_openscm.index_manipulation.set_levels][] and the corresponding accessor [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.set_index_levels][] ([#18](https://github.com/openscm/pandas-openscm/pull/18))
+- Added [pandas_openscm.index_manipulation.set_levels][] and the corresponding accessor [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.set_index_levels][] ([#18](https://github.com/openscm/pandas-openscm/pull/18))
 
 
 ## Pandas-OpenSCM v0.5.0 (2025-05-10)
@@ -84,7 +84,7 @@ from the examples given in that link.
 ### 🆕 Features
 
 - Add compare_close function to compare two dataframes. ([#16](https://github.com/openscm/pandas-openscm/pull/16))
-- Added [pandas_openscm.index_manipulation.update_levels_from_other][] and the corresponding accessor [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.update_index_levels_from_other][] ([#17](https://github.com/openscm/pandas-openscm/pull/17))
+- Added [pandas_openscm.index_manipulation.update_levels_from_other][] and the corresponding accessor [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.update_index_levels_from_other][] ([#17](https://github.com/openscm/pandas-openscm/pull/17))
 
 
 ## Pandas-OpenSCM v0.4.1 (2025-04-12)
@@ -93,21 +93,21 @@ from the examples given in that link.
 
 - Fixed up [pandas_openscm.index_manipulation.update_levels][].
   It now drops unused levels by default first, to avoid applying the updates to values that aren't being used.
-  The same fixes are propagated to [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.update_index_levels][] and [pandas_openscm.index_manipulation.update_index_levels_func][]. ([#14](https://github.com/openscm/pandas-openscm/pull/14))
+  The same fixes are propagated to [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.update_index_levels][] and [pandas_openscm.index_manipulation.update_index_levels_func][]. ([#14](https://github.com/openscm/pandas-openscm/pull/14))
 
 
 ## Pandas-OpenSCM v0.4.0 (2025-04-11)
 
 ### 🆕 Features
 
-- Added [pandas_openscm.index_manipulation.update_levels][] and the corresponding accessor [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.update_index_levels][] ([#13](https://github.com/openscm/pandas-openscm/pull/13))
+- Added [pandas_openscm.index_manipulation.update_levels][] and the corresponding accessor [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.update_index_levels][] ([#13](https://github.com/openscm/pandas-openscm/pull/13))
 
 
 ## Pandas-OpenSCM v0.3.3 (2025-03-30)
 
 ### 🆕 Features
 
-- - Added a method for converting to long data, see [pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.to_long_data][pandas_openscm.accessors.DataFramePandasOpenSCMAccessor.to_long_data] ([#12](https://github.com/openscm/pandas-openscm/pull/12))
+- - Added a method for converting to long data, see [pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.to_long_data][pandas_openscm.accessors.PandasDataFrameOpenSCMAccessor.to_long_data] ([#12](https://github.com/openscm/pandas-openscm/pull/12))
 
 
 ## Pandas-OpenSCM v0.3.2 (2025-03-27)

docs/pandas-accessors.md

@@ -13,7 +13,7 @@ This is done with
 By default, the accessors are provided under the "openscm" namespace
 and this is how the accessors are documented below.
 However, the namespace can be customised when using
-[register_pandas_accessor][pandas_openscm.accessors.register_pandas_accessor],
+[register_pandas_accessors][pandas_openscm.accessors.register_pandas_accessors],
 should you wish to use a different namespace for the accessor.
 
 For the avoidance of doubt, in order to register/activate the accessors,
@@ -22,21 +22,29 @@ you will need to run something like:
 ```python
 from pandas_openscm.accessors import register_pandas_accessors
 
-# The 'pd.DataFrame.openscm' namespace will not be available at this point.
+# The 'pd.DataFrame.openscm' and 'pd.Series.openscm' namespace
+# will not be available at this point.
 
 # Register the accessors
 register_pandas_accessors()
 
-# The 'pd.DataFrame.openscm' namespace
+# The 'pd.DataFrame.openscm' and 'pd.Series.openscm' namespace
 # (or whatever other custom namespace you chose to register)
 # will now be available.
 ```
 
 The full accessor API is documented below.
 
-::: pandas_openscm.accessors.DataFramePandasOpenSCMAccessor
+::: pandas_openscm.accessors.dataframe.PandasDataFrameOpenSCMAccessor
     handler: python_accessors
     options:
         namespace: "pd.DataFrame.openscm"
         show_root_full_path: false
         show_root_heading: true
+
+::: pandas_openscm.accessors.series.PandasSeriesOpenSCMAccessor
+    handler: python_accessors
+    options:
+        namespace: "pd.Series.openscm"
+        show_root_full_path: false
+        show_root_heading: true

src/pandas_openscm/accessors/dataframe.py

@@ -70,7 +70,7 @@ def convert_unit(
         """
         Convert units
 
-        This uses [convert_unit_from_target_series][(p).unit_conversion.].
+        This uses [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
         If you want to understand the details of how the conversion works,
         see that function's docstring.
 
@@ -91,23 +91,25 @@ def convert_unit(
 
             If this is a [pd.Series][pandas.Series],
             then it will be passed to
-            [convert_unit_from_target_series][(p).unit_conversion.]
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.]
             after filling any rows in the [pd.DataFrame][pandas.DataFrame]
             that are not in `desired_units`
             with the existing unit (i.e. unspecified rows are not converted).
 
             For further details, see the examples
-            in [convert_unit][(p).unit_conversion.].
+            in [convert_unit][pandas_openscm.unit_conversion.].
 
         unit_level
             Level in the index which holds unit information
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         ur
             Unit registry to use for the conversion.
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         Returns
         -------
@@ -129,16 +131,16 @@ def convert_unit_like(
         Convert units to match another [pd.DataFrame][pandas.DataFrame]
 
         For further details, see the examples
-        in [convert_unit_like][(p).unit_conversion.].
+        in [convert_unit_like][pandas_openscm.unit_conversion.].
 
         This is essentially a helper for
-        [convert_unit_from_target_series][(p).unit_conversion.].
+        [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
         It implements one set of logic for extracting desired units
         and tries to be clever, handling differences in index levels
         between the data and `target` sensibly wherever possible.
 
         If you want behaviour other than what is implemented here,
-        use [convert_unit_from_target_series][(p).unit_conversion.] directly.
+        use [convert_unit_from_target_series][pandas_openscm.unit_conversion.] directly.
 
         Parameters
         ----------
@@ -156,7 +158,8 @@ def convert_unit_like(
         ur
             Unit registry to use for the conversion.
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         Returns
         -------
@@ -194,7 +197,7 @@ def eiim(self, copy: bool = True) -> pd.DataFrame:
         """
         Ensure that the index is a [pd.MultiIndex][pandas.MultiIndex]
 
-        Alias for [ensure_index_is_multiindex][(p).index_manipulation.]
+        Alias for [ensure_index_is_multiindex][pandas_openscm.index_manipulation.]
 
         Parameters
         ----------
@@ -276,7 +279,7 @@ def mi_loc(
             Locator to apply
 
             If this is a multi-index, we use
-            [multi_index_lookup][(p).indexing.] to ensure correct alignment.
+            [multi_index_lookup][pandas_openscm.indexing.] to ensure correct alignment.
 
             If this is an index that has a name,
             we use the name to ensure correct alignment.

src/pandas_openscm/accessors/series.py

@@ -50,7 +50,7 @@ def convert_unit(
         """
         Convert units
 
-        This uses [convert_unit_from_target_series][(p).unit_conversion.].
+        This uses [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
         If you want to understand the details of how the conversion works,
         see that function's docstring.
 
@@ -71,23 +71,25 @@ def convert_unit(
 
             If this is a [pd.Series][pandas.Series],
             then it will be passed to
-            [convert_unit_from_target_series][(p).unit_conversion.]
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.]
             after filling any rows in the [pd.Series][pandas.Series]
             that are not in `desired_units`
             with the existing unit (i.e. unspecified rows are not converted).
 
             For further details, see the examples
-            in [convert_unit][(p).unit_conversion.].
+            in [convert_unit][pandas_openscm.unit_conversion.].
 
         unit_level
             Level in the index which holds unit information
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         ur
             Unit registry to use for the conversion.
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         Returns
         -------
@@ -120,16 +122,16 @@ def convert_unit_like(
         Convert units to match another supported pandas object
 
         For further details, see the examples
-        in [convert_unit_like][(p).unit_conversion.].
+        in [convert_unit_like][pandas_openscm.unit_conversion.].
 
         This is essentially a helper for
-        [convert_unit_from_target_series][(p).unit_conversion.].
+        [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
         It implements one set of logic for extracting desired units
         and tries to be clever, handling differences in index levels
         between the data and `target` sensibly wherever possible.
 
         If you want behaviour other than what is implemented here,
-        use [convert_unit_from_target_series][(p).unit_conversion.] directly.
+        use [convert_unit_from_target_series][pandas_openscm.unit_conversion.] directly.
 
         Parameters
         ----------
@@ -147,7 +149,8 @@ def convert_unit_like(
         ur
             Unit registry to use for the conversion.
 
-            Passed to [convert_unit_from_target_series][(p).unit_conversion.].
+            Passed to
+            [convert_unit_from_target_series][pandas_openscm.unit_conversion.].
 
         Returns
         -------
@@ -196,7 +199,7 @@ def convert_unit_like(
     #     """
     #     Ensure that the index is a [pd.MultiIndex][pandas.MultiIndex]
     #
-    #     Alias for [ensure_index_is_multiindex][(p).index_manipulation.]
+    #     Alias for [ensure_index_is_multiindex][pandas_openscm.index_manipulation.]
     #
     #     Parameters
     #     ----------
@@ -278,7 +281,7 @@ def convert_unit_like(
     #         Locator to apply
     #
     #         If this is a multi-index, we use
-    #         [multi_index_lookup][(p).indexing.] to ensure correct alignment.
+    #         [multi_index_lookup][pandas_openscm.indexing.] to ensure correct alignment.  # noqa: E501
     #
     #         If this is an index that has a name,
     #         we use the name to ensure correct alignment.

src/pandas_openscm/index_manipulation.py

@@ -920,20 +920,19 @@ def set_index_levels_func(
 
     Parameters
     ----------
-    df
+    pobj
         [pd.DataFrame][pandas.DataFrame] to update
 
     levels_to_set
         Mapping of level names to values to set
 
     copy
-        Should `df` be copied before returning?
-
+        Should `pobj` be copied before returning?
 
     Returns
     -------
     :
-        `df` with updates applied to its index
+        `pobj` with updates applied to its index
     """
     if not isinstance(pobj.index, pd.MultiIndex):
         msg = (