Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GEOPY-1333: geoh5py uijson documentation #630

Merged
merged 8 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 57 additions & 37 deletions docs/content/api/geoh5py.data.rst
Original file line number Diff line number Diff line change
@@ -1,143 +1,163 @@
geoh5py.data
============
geoh5py.data package
====================

Submodules
----------

geoh5py.data.blob\_data
-----------------------
geoh5py.data.blob\_data module
------------------------------

.. automodule:: geoh5py.data.blob_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.color\_map
-----------------------
geoh5py.data.boolean\_data module
---------------------------------

.. automodule:: geoh5py.data.boolean_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.color\_map module
------------------------------

.. automodule:: geoh5py.data.color_map
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.data
-----------------
geoh5py.data.data module
------------------------

.. automodule:: geoh5py.data.data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.data\_association\_enum
------------------------------------
geoh5py.data.data\_association\_enum module
-------------------------------------------

.. automodule:: geoh5py.data.data_association_enum
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.data\_type
-----------------------
geoh5py.data.data\_type module
------------------------------

.. automodule:: geoh5py.data.data_type
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.data\_unit
-----------------------
geoh5py.data.data\_unit module
------------------------------

.. automodule:: geoh5py.data.data_unit
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.datetime\_data
---------------------------
geoh5py.data.datetime\_data module
----------------------------------

.. automodule:: geoh5py.data.datetime_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.filename\_data
---------------------------
geoh5py.data.filename\_data module
----------------------------------

.. automodule:: geoh5py.data.filename_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.float\_data
------------------------
geoh5py.data.float\_data module
-------------------------------

.. automodule:: geoh5py.data.float_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.geometric\_data\_constants
---------------------------------------
geoh5py.data.geometric\_data module
-----------------------------------

.. automodule:: geoh5py.data.geometric_data_constants
.. automodule:: geoh5py.data.geometric_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.integer\_data
--------------------------
geoh5py.data.integer\_data module
---------------------------------

.. automodule:: geoh5py.data.integer_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.numeric\_data
--------------------------
geoh5py.data.numeric\_data module
---------------------------------

.. automodule:: geoh5py.data.numeric_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.primitive\_type\_enum
----------------------------------
geoh5py.data.primitive\_type\_enum module
-----------------------------------------

.. automodule:: geoh5py.data.primitive_type_enum
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.reference\_value\_map
----------------------------------
geoh5py.data.reference\_value\_map module
-----------------------------------------

.. automodule:: geoh5py.data.reference_value_map
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.referenced\_data
-----------------------------
geoh5py.data.referenced\_data module
------------------------------------

.. automodule:: geoh5py.data.referenced_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.text\_data
-----------------------
geoh5py.data.text\_data module
------------------------------

.. automodule:: geoh5py.data.text_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.unknown\_data
--------------------------
geoh5py.data.unknown\_data module
---------------------------------

.. automodule:: geoh5py.data.unknown_data
:members:
:undoc-members:
:show-inheritance:

geoh5py.data.visual\_parameters module
--------------------------------------

.. automodule:: geoh5py.data.visual_parameters
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: geoh5py.data
:members:
Expand Down
86 changes: 53 additions & 33 deletions docs/content/api/geoh5py.groups.rst
Original file line number Diff line number Diff line change
@@ -1,111 +1,131 @@
geoh5py.groups
==============
geoh5py.groups package
======================

Submodules
----------

geoh5py.groups.container\_group
-------------------------------
geoh5py.groups.base module
--------------------------

.. automodule:: geoh5py.groups.container_group
.. automodule:: geoh5py.groups.base
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.custom\_group
----------------------------
geoh5py.groups.container module
-------------------------------

.. automodule:: geoh5py.groups.custom_group
.. automodule:: geoh5py.groups.container
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.drillhole\_group
-------------------------------
geoh5py.groups.custom module
----------------------------

.. automodule:: geoh5py.groups.drillhole_group
.. automodule:: geoh5py.groups.custom
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.giftools\_group
------------------------------
geoh5py.groups.drillhole module
-------------------------------

.. automodule:: geoh5py.groups.giftools_group
.. automodule:: geoh5py.groups.drillhole
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.group
--------------------
geoh5py.groups.giftools module
------------------------------

.. automodule:: geoh5py.groups.group
.. automodule:: geoh5py.groups.giftools
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.group\_type
--------------------------
geoh5py.groups.group\_type module
---------------------------------

.. automodule:: geoh5py.groups.group_type
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.integrator\_group
geoh5py.groups.integrator module
--------------------------------

.. automodule:: geoh5py.groups.integrator_group
.. automodule:: geoh5py.groups.integrator
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.maps\_group
geoh5py.groups.maps module
--------------------------

.. automodule:: geoh5py.groups.maps_group
.. automodule:: geoh5py.groups.maps
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.notype\_group
geoh5py.groups.notype module
----------------------------

.. automodule:: geoh5py.groups.notype_group
.. automodule:: geoh5py.groups.notype
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.property\_group
------------------------------
geoh5py.groups.property\_group module
-------------------------------------

.. automodule:: geoh5py.groups.property_group
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.root\_group
geoh5py.groups.property\_group\_table module
--------------------------------------------

.. automodule:: geoh5py.groups.property_group_table
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.root module
--------------------------

.. automodule:: geoh5py.groups.root_group
.. automodule:: geoh5py.groups.root
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.simpeg module
----------------------------

.. automodule:: geoh5py.groups.simpeg
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.simpeg\_group
geoh5py.groups.survey module
----------------------------

.. automodule:: geoh5py.groups.simpeg_group
.. automodule:: geoh5py.groups.survey
:members:
:undoc-members:
:show-inheritance:

geoh5py.groups.survey\_group
geoh5py.groups.uijson module
----------------------------

.. automodule:: geoh5py.groups.survey_group
.. automodule:: geoh5py.groups.uijson
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: geoh5py.groups
:members:
Expand Down
Loading
Loading