GEOPY-2456: Solve warning issues raised by RTD

[domfournier]

GEOPY-2456 - Solve warning issues raised by RTD

[codecov]

Codecov Report

❌ Patch coverage is 96.29630% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 91.16%. Comparing base (ff3ab14) to head (3d18d5f).

Files with missing lines	Patch %	Lines
geoh5py/objects/surveys/electromagnetics/base.py	75.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@               Coverage Diff               @@
##           release/GA_4.8     #906   +/-   ##
===============================================
  Coverage           91.16%   91.16%           
===============================================
  Files                 114      114           
  Lines               10595    10597    +2     
  Branches             1964     1964           
===============================================
+ Hits                 9659     9661    +2     
  Misses                493      493           
  Partials              443      443           

Files with missing lines	Coverage Δ
geoh5py/groups/base.py	86.79% <100.00%> (ø)
geoh5py/objects/surveys/base.py	92.42% <100.00%> (ø)
geoh5py/objects/surveys/direct_current.py	83.06% <100.00%> (ø)
...jects/surveys/electromagnetics/airborne_app_con.py	89.88% <100.00%> (ø)
...y/objects/surveys/electromagnetics/airborne_fem.py	95.12% <100.00%> (ø)
...y/objects/surveys/electromagnetics/airborne_tem.py	95.00% <100.00%> (ø)
...5py/objects/surveys/electromagnetics/ground_fem.py	98.75% <100.00%> (ø)
...5py/objects/surveys/electromagnetics/ground_tem.py	100.00% <100.00%> (ø)
...jects/surveys/electromagnetics/magnetotellurics.py	94.59% <100.00%> (ø)
geoh5py/objects/surveys/electromagnetics/tipper.py	89.88% <100.00%> (ø)
... and 3 more

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull request overview

This PR targets ReadTheDocs (RTD) build warnings by improving Pydantic autodoc compatibility, updating documentation cross-references, and renaming a survey “type” discriminator property to avoid conflicts.

Changes:

• Add explicit __pydantic_extra__ typing to UI JSON Pydantic models to silence autodoc issues.
• Rename Survey.type → Survey.type_name across survey implementations and dependent code paths.
• Update multiple user-guide notebooks to use {py:...} Sphinx roles instead of hard-coded RST anchor links.

Reviewed changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
tests/ui_json/uijson_test.py	Adds Any import for typing/autodoc-related needs in tests.
tests/ui_json/forms_test.py	Adjusts imports to align with updated typing/autodoc needs.
geoh5py/ui_json/ui_json.py	Adds __pydantic_extra__ annotation for Pydantic autodoc compatibility.
geoh5py/ui_json/forms.py	Adds __pydantic_extra__ annotation for Pydantic autodoc compatibility.
geoh5py/objects/surveys/electromagnetics/tipper.py	Renames type property to type_name.
geoh5py/objects/surveys/electromagnetics/magnetotellurics.py	Renames type property to type_name.
geoh5py/objects/surveys/electromagnetics/ground_tem.py	Renames type property to type_name across TEM survey elements.
geoh5py/objects/surveys/electromagnetics/ground_fem.py	Renames type property to type_name across FEM survey elements.
geoh5py/objects/surveys/electromagnetics/base.py	Updates internal logic to use type_name instead of type.
geoh5py/objects/surveys/electromagnetics/airborne_tem.py	Renames type property to type_name.
geoh5py/objects/surveys/electromagnetics/airborne_fem.py	Renames type property to type_name.
geoh5py/objects/surveys/electromagnetics/airborne_app_con.py	Renames type property to type_name.
geoh5py/objects/surveys/direct_current.py	Renames type property to type_name for DC survey elements.
geoh5py/objects/surveys/base.py	Changes abstract API surface from type to type_name.
geoh5py/groups/base.py	Updates copy logic to use type_name for survey children filtering.
docs/content/user_guide/tipper.ipynb	Replaces RST anchor links with {py:...} Sphinx roles; updates notebook metadata.
docs/content/user_guide/objects.ipynb	Updates a method reference to {py:func} and notebook metadata.
docs/content/user_guide/magnetotelluric.ipynb	Replaces RST anchor links with {py:...} Sphinx roles; updates notebook metadata.
docs/content/user_guide/direct_current.ipynb	Replaces RST anchor links with {py:...} Sphinx roles; minor wording/metadata updates.
docs/content/user_guide/data.ipynb	Adds a section label and updates links/references to Sphinx roles; updates notebook metadata.
docs/content/user_guide/airborne_tem.ipynb	Replaces RST anchor links with {py:...} Sphinx roles; updates kernelspec/metadata.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.