Minor doc changes. (#82)

dgbowl · Aug 22, 2022 · 2712ced · 2712ced
1 parent a509411
commit 2712ced
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 9 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -74,9 +74,12 @@
 
 
 # -- Extension configuration -------------------------------------------------
-
-autosummary_generate = True
+show_authors = True
+autosummary_generate = False
 autodoc_default_flags = ["members", "undoc-members", "show-inheritance"]
+autodoc_member_order = "bysource"
+autodoc_pydantic_model_show_field_summary = False
+autodoc_pydantic_model_member_order = "bysource"
 
 autodoc_pydantic_model_show_field_summary = False
 autodoc_pydantic_model_member_order = "bysource"

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,7 @@
 **yadg**: yet another datagram
 ==============================
 
-yadg is a set of tools and parsers aimed to process raw instrument data.
+**yadg** is a set of tools and parsers aimed to process raw instrument data.
 
 .. image:: images/schema_yadg_datagram.png
    :width: 600
@@ -23,7 +23,7 @@ the `datagram` contains instrumental error estimates and is annotated with units
 You can read more about yadg in our paper: [Kraus2022b]_.
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
    :caption: yadg user manual
 
    usage

diff --git a/docs/source/parsers.rst b/docs/source/parsers.rst
@@ -1,8 +1,5 @@
-Parsers available in **yadg**
------------------------------
-
-yadg offloads the responsibility of processing the raw data files to its modules, 
-called parsers. The currently implemented parsers are documented in the 
+**yadg** offloads the responsibility of processing the raw data files to its 
+modules, called parsers. The currently implemented parsers are documented in the 
 following links:
 
 .. toctree::

diff --git a/docs/source/version.4_2.rst b/docs/source/version.4_2.rst
@@ -32,6 +32,8 @@ Backwards-incompatible changes include:
 
 Bug fixes include:
 
+  - the :func:`~yadg.parsers.basiccsv.process_row` from the :mod:`~yadg.parsers.basiccsv`
+    parser now handles empty cells by creating sparse `datagrams`;
   - the ``drycal`` filetypes in :mod:`~yadg.parsers.flowdata` should now work for 
     overnight experiments;
   - the metadata in :mod:`~yadg.parsers.chromdata` and :mod:`~yadg.parsers.chromtrace`