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

Updated documentation with Utility Functions #229

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
5 changes: 4 additions & 1 deletion doc/source/methods/geometry_functions.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
.. currentmodule:: ansys.motorcad.core.geometry
.. _ref_geometry_functions:
Adaptive geometry
=================

.. currentmodule:: ansys.motorcad.core.geometry

Add some info here about adaptive geometry


Expand Down
15 changes: 15 additions & 0 deletions doc/source/methods/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,25 @@ object, its single class, and its many methods, see
In addition to giving the available methods, their replacement functions
have been commented.

Adaptive geometry
JackB-Ansys marked this conversation as resolved.
Show resolved Hide resolved
------------------

Adaptive geometry can be used to set up custom geometries in Motor-CAD.
For descriptions of adaptive geometry objects and functions, see
:ref:`ref_geometry_functions`.

Utility functions
------------------

A number of utility functions are available to the user.
For descriptions, see
JackB-Ansys marked this conversation as resolved.
Show resolved Hide resolved
:ref:`ref_utility_functions`.

.. toctree::
:maxdepth: 1
:hidden:

MotorCAD_object
MotorCADCompatibility_object
geometry_functions
utility_functions
15 changes: 15 additions & 0 deletions doc/source/methods/utility_functions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _ref_utility_functions:

Utility functions
==================

.. currentmodule:: ansys.motorcad.core.rpc_client_core


.. autosummary::
:toctree: _autosummary_utility_functions

MotorCADError
JackB-Ansys marked this conversation as resolved.
Show resolved Hide resolved
set_default_instance
JackB-Ansys marked this conversation as resolved.
Show resolved Hide resolved
set_motorcad_exe
set_server_ip
Loading