Updating PySherlock Docs

Changing to use the class names instead of defining each method in the RST files.
ansys · Oct 17, 2023 · a0db4a7 · a0db4a7
1 parent a2cd585
commit a0db4a7
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 65 deletions.
diff --git a/doc/source/api/analysis.rst b/doc/source/api/analysis.rst
@@ -3,25 +3,9 @@
 Analysis
 ========
 
-The ``analysis`` module contains all analysis capabilities.
-
-.. currentmodule:: ansys.sherlock.core.analysis
+.. automodule:: ansys.sherlock.core.analysis
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.analysis.Analysis.get_harmonic_vibe_input_fields
-     ansys.sherlock.core.analysis.Analysis.get_ict_analysis_input_fields
-     ansys.sherlock.core.analysis.Analysis.get_mechanical_shock_input_fields
-     ansys.sherlock.core.analysis.Analysis.get_random_vibe_input_fields
-     ansys.sherlock.core.analysis.Analysis.get_solder_fatigue_input_fields
-     ansys.sherlock.core.analysis.Analysis.run_analysis
-     ansys.sherlock.core.analysis.Analysis.run_strain_map_analysis
-     ansys.sherlock.core.analysis.Analysis.update_harmonic_vibe_props
-     ansys.sherlock.core.analysis.Analysis.update_ict_analysis_props
-     ansys.sherlock.core.analysis.Analysis.update_mechanical_shock_props
-     ansys.sherlock.core.analysis.Analysis.update_natural_frequency_props
-     ansys.sherlock.core.analysis.Analysis.update_part_modeling_props
-     ansys.sherlock.core.analysis.Analysis.update_pcb_modeling_props
-     ansys.sherlock.core.analysis.Analysis.update_random_vibe_props
-     ansys.sherlock.core.analysis.Analysis.update_solder_fatigue_props
+     ansys.sherlock.core.analysis.Analysis
diff --git a/doc/source/api/common.rst b/doc/source/api/common.rst
@@ -3,15 +3,9 @@
 Common
 ======
 
-The ``common`` module contains all common capabilities.
-
-.. currentmodule:: ansys.sherlock.core.common
+.. automodule:: ansys.sherlock.core.common
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.common.Common.check
-     ansys.sherlock.core.common.Common.exit
-     ansys.sherlock.core.common.Common.is_sherlock_client_loading
-     ansys.sherlock.core.common.Common.list_solder_materials
-     ansys.sherlock.core.common.Common.list_units
+     ansys.sherlock.core.common.Common
diff --git a/doc/source/api/launcher.rst b/doc/source/api/launcher.rst
@@ -4,9 +4,7 @@
 Launcher
 ========
 
-The ``launcher`` module launches the Sherlock gRPC server and a Sherlock client.
-
-.. currentmodule:: ansys.sherlock.core.launcher
+.. automodule:: ansys.sherlock.core.launcher
 
 .. autosummary::
      :toctree: _autosummary

diff --git a/doc/source/api/layer.rst b/doc/source/api/layer.rst
@@ -4,12 +4,9 @@
 Layer
 =====
 
-The ``layer`` module contains all layer management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.layer
+.. automodule:: ansys.sherlock.core.layer
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.layer.Layer.update_mount_points_by_file
-     ansys.sherlock.core.layer.Layer.add_potting_region
+     ansys.sherlock.core.layer.Layer
diff --git a/doc/source/api/lifecycle.rst b/doc/source/api/lifecycle.rst
@@ -4,21 +4,9 @@
 Lifecycle
 =========
 
-The ``lifecycle`` module contains all life cycle management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.lifecycle
+.. automodule:: ansys.sherlock.core.lifecycle
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_harmonic_vibe_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_random_vibe_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_shock_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_shock_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_event
-     ansys.sherlock.core.lifecycle.Lifecycle.add_thermal_profiles
-     ansys.sherlock.core.lifecycle.Lifecycle.create_life_phase
-     ansys.sherlock.core.lifecycle.Lifecycle.load_harmonic_profile
-     ansys.sherlock.core.lifecycle.Lifecycle.load_random_vibe_profile
+     ansys.sherlock.core.lifecycle.Lifecycle
diff --git a/doc/source/api/model.rst b/doc/source/api/model.rst
@@ -3,12 +3,9 @@
 Model
 =====
 
-The ``model`` module contains all model generation capabilities.
-
-.. currentmodule:: ansys.sherlock.core.model
+.. automodule:: ansys.sherlock.core.model
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.model.Model.export_trace_reinforcement_model
-     ansys.sherlock.core.model.Model.generate_trace_model
+     ansys.sherlock.core.model.Model
diff --git a/doc/source/api/project.rst b/doc/source/api/project.rst
@@ -3,19 +3,9 @@
 Project
 =======
 
-The ``project`` module contains all project management capabilities.
-
-.. currentmodule:: ansys.sherlock.core.project
+.. automodule:: ansys.sherlock.core.project
 
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.project.Project.add_cca
-     ansys.sherlock.core.project.Project.add_strain_maps
-     ansys.sherlock.core.project.Project.delete_project
-     ansys.sherlock.core.project.Project.generate_project_report
-     ansys.sherlock.core.project.Project.import_odb_archive
-     ansys.sherlock.core.project.Project.import_ipc2581_archive
-     ansys.sherlock.core.project.Project.list_ccas
-     ansys.sherlock.core.project.Project.list_strain_maps
-     ansys.sherlock.core.project.Project.add_project
+     ansys.sherlock.core.project.Project