second iteration of API documentation clean-up prior to next release (#…

…354)

RELEASE_NOTES.md

@@ -15,6 +15,7 @@ an IamDataFrame with `n/a` entries in columns other than `value` raises an error
 
 ## Individual Updates
 
+- [#354](https://github.com/IAMconsortium/pyam/pull/354) Fixes formatting of API parameter docstrings
 - [#352](https://github.com/IAMconsortium/pyam/pull/352) Bugfix when using `interpolate()` on data with extra columns
 - [#349](https://github.com/IAMconsortium/pyam/pull/349) Fixes an issue with checking that time columns are equal when appending IamDataFrames
 - [#348](https://github.com/IAMconsortium/pyam/pull/348) Extend pages for API docs, clean up docstrings, and harmonize formatting

doc/source/conf.py

@@ -143,6 +143,7 @@
     'logo': 'logo.svg',
     'logo_name': True,
     'description': 'analysis & visualization of integrated-assessment scenarios',
+    'page_width': '1120px',
     'sidebar_width': '230px',
     'github_button': True,
     'github_user': 'iamconsortium',
@@ -325,7 +326,8 @@
     'python': ('https://docs.python.org/3', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
-    'pint': ('https://pint.readthedocs.io/en/stable', None)
+    'pint': ('https://pint.readthedocs.io/en/stable', None),
+    'ixmp': ('https://message.iiasa.ac.at/projects/ixmp/en/stable/', None)
 }
 
 # extend the timeout limit for running notebooks
@@ -340,4 +342,9 @@
 
     <br>
 
+.. |datapackage.Package.docs| raw:: html
+
+   <a href="https://github.com/frictionlessdata/datapackage-py#package">read
+   the docs</a>
+
 """

doc/source/index.rst

@@ -52,9 +52,9 @@ energy systems analysis, and sectoral studies.
 Key features:
 ~~~~~~~~~~~~~
 
- - Simple analysis of timeseries data in the IAMC format (more about it `here`_)
+ - Simple analysis of timeseries data in the IAMC format (more about it `here`_) |br|
    with an interface similar in feel & style to the widely
-   used :py:class:`pandas.DataFrame`
+   used :class:`pandas.DataFrame`
  - Advanced visualization and plotting functions (see the `gallery`_)
  - Features for scripted validation & processing of scenario data
    and results

doc/source/tutorials/data_table_formats.ipynb

@@ -405,7 +405,7 @@
     "<div class=\"alert alert-warning\">\n",
     "\n",
     "The *custom data column* feature is currently only on experimental support.\n",
-    "Not all **pyam** functions currently support custom columns in a `data` table.\n",
+    "Not all **pyam** functions currently support custom columns in a 'data' table.\n",
     "If you encounter any problems, please remove any non-standard columns\n",
     "from the input dataframe (or [contribute](https://pyam-iamc.readthedocs.io/en/stable/contributing.html) to fix the problem!).\n",
     "\n",

doc/source/tutorials/unit_conversion.ipynb

@@ -8,8 +8,8 @@
     "\n",
     "Conversion of timeseries data units is one of the most tedious aspects of modelling and scenario analysis -\n",
     "and it is a frequent source for errors!\n",
-    "The **pyam** function [convert_unit()](https://pyam-iamc.readthedocs.io/en/stable/api/iamdataframe.html#pyam.IamDataFrame.convert_unit) can support and simplify this task.\n",
     "\n",
+    "The **pyam** function [convert_unit()](https://pyam-iamc.readthedocs.io/en/stable/api/iamdataframe.html#pyam.IamDataFrame.convert_unit) can support and simplify this task.\n",
     "The function uses the Python package [pint](https://pint.readthedocs.io),\n",
     "which natively handles conversion of standard (SI) units and commonly used equivalents \n",
     "(e.g., exajoule to terawatt-hours, `EJ -> TWh`).\n",