Fix docs (#147)

* Build things better * Resolve warnings * Newline for indent
dgbowl · Apr 7, 2024 · e4729a7 · e4729a7
1 parent f976fa5
commit e4729a7
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 6 deletions.
diff --git a/.github/workflows/workflow-pages.yml b/.github/workflows/workflow-pages.yml
@@ -31,8 +31,8 @@ jobs:
           - name: Build the docs
             shell: bash
             run: |
-                sphinx-apidoc -o docs/source/apidoc src/yadg -T -M -E -f --templatedir=docs/apidoc_t
-                sphinx-build -b html docs/source public/master
+                sphinx-apidoc -o docs/source/apidoc src/yadg -T -M -f --templatedir=docs/apidoc_t
+                sphinx-build -W -b html docs/source public/master
           - uses: actions/upload-artifact@v4
             with:
               name: public-${{ inputs.os }}-${{ inputs.pyver }}

diff --git a/docs/apidoc_t/package.rst_t b/docs/apidoc_t/package.rst_t
@@ -41,6 +41,8 @@
 {{- "**quadstar**: For Quadstar MS data" | heading }}
 {% elif 'yadg.extractors.tomato' == pkgname %}
 {{- "**tomato**: For tomato outputs" | heading }}
+{% elif 'yadg.extractors.touchstone' == pkgname %}
+{{- "**touchstone**: For Touchstone VNA files" | heading }}
 {% else %}
 {{- [pkgname, "package"] | join(" ") | e | heading }}
 {% endif %}

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -79,8 +79,7 @@
 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_show_json = False
 autodoc_pydantic_model_member_order = "bysource"
 intersphinx_mapping = {
     "dgbowl_schemas": ("https://dgbowl.github.io/dgbowl-schemas/master", None),

diff --git a/docs/source/version.5_1.rst b/docs/source/version.5_1.rst
@@ -12,6 +12,7 @@ Developed in the |concat_lab|_ at Technische Universität Berlin (Berlin, DE).
 New features since ``yadg-5.0`` are:
 
   - Support for Touchstone ``.sNp`` files using the :mod:`yadg.extractors.touchstone.snp` extractor. Test files are truncated to first 100 lines, they were obtained from the following DOIs:
+
     - ``Device_r_*um.s1p`` from https://zenodo.org/doi/10.5281/zenodo.7850136
     - ``SCENARIO*_pulserside_30k_3G.s1p`` from https://zenodo.org/doi/10.5281/zenodo.10016477
     - ``CABLE_3_5MM_1N_TYPE_CONNECTORS.S2P`` from https://zenodo.org/doi/10.5281/zenodo.10016477

diff --git a/src/yadg/extractors/agilent/dx.py b/src/yadg/extractors/agilent/dx.py
@@ -13,7 +13,7 @@
 `````
 Available since ``yadg-4.0``.
 
-.. autopydantic_model:: dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_ch
+.. autopydantic_model:: dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_dx
 
 Schema
 ``````

diff --git a/src/yadg/extractors/touchstone/snp.py b/src/yadg/extractors/touchstone/snp.py
@@ -1,6 +1,6 @@
 """
 This module parses Touchstone files conforming to the Touchstone File Specification,
-:ref:`revision 1.1 <https://ibis.org/connector/touchstone_spec11.pdf>`_.
+`revision 1.1 <https://ibis.org/connector/touchstone_spec11.pdf>`_.
 
 .. note::
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,7 +13,7 @@ @@
     `````
     Available since ``yadg-4.0``.
-    .. autopydantic_model:: dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_ch
+    .. autopydantic_model:: dgbowl_schemas.yadg.dataschema_5_1.filetype.Agilent_dx
     Schema
     ``````
@@ Expand Down @@