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

docs: extracting information to another rst file #3549

Merged
merged 4 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
1 change: 1 addition & 0 deletions doc/changelog.d/3549.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: extracting information to another rst file
1 change: 1 addition & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ PyMAPDL, see :ref:`ref_mapdl_commands`.
database
geometry
helper
information
inline
krylov
launcher
Expand Down
35 changes: 35 additions & 0 deletions doc/source/api/information.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _ref_information_api:

``Information`` module
======================

``Information`` class attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: ansys.mapdl.core.information

.. autosummary::
:toctree: _autosummary

Information.aux_capabilities
Information.boundary_condition_information
Information.config_values
Information.database_status
Information.global_status
Information.job_information
Information.load_step_options
Information.mapdl_version
Information.model_information
Information.post_capabilities
Information.preprocessing_capabilities
Information.product
Information.products
Information.pymapdl_version
Information.routine_information
Information.scratch_memory_status
Information.solution_options
Information.solution_options_configuration
Information.stitles
Information.title
Information.titles
Information.units
90 changes: 53 additions & 37 deletions doc/source/api/mapdl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,69 @@
:toctree: _autosummary

Mapdl.add_file_handler
Mapdl.allow_ignore
Mapdl.busy
Mapdl.chain_commands
Mapdl.check_parameter_names
Mapdl.default_file_type_for_plots
Mapdl.directory
Mapdl.exited
Mapdl.exiting
Mapdl.file
Mapdl.file_type_for_plots
Mapdl.finish_job_on_exit
Mapdl.force_output
Mapdl.get
Mapdl.get_array
Mapdl.get_esol
Mapdl.get_nodal_constrains
Mapdl.get_nodal_loads
Mapdl.get_nsol
Mapdl.get_value
Mapdl.get_variable
Mapdl.hostname
Mapdl.ignore_errors
Mapdl.info
Mapdl.input_strings
Mapdl.is_alive
Mapdl.is_console
Mapdl.is_corba
Mapdl.is_grpc
Mapdl.jobid
Mapdl.jobname
Mapdl.kill_job
Mapdl.last_response
Mapdl.launched
Mapdl.list_error_file
Mapdl.list_files
Mapdl.load_array
Mapdl.load_table
Mapdl.mesh
Mapdl.modal_analysis
Mapdl.locked
Mapdl.logger
Mapdl.mapdl_on_hpc
Mapdl.mute
Mapdl.name
Mapdl.non_interactive
Mapdl.on_docker
Mapdl.open_apdl_log
Mapdl.open_gui
Mapdl.parameters
Mapdl.platform
Mapdl.print_com
Mapdl.process_is_alive
Mapdl.remove_file_handler
Mapdl.remove_temp_dir_on_exit
Mapdl.result
Mapdl.result_file
Mapdl.run
Mapdl.run_as_routine
Mapdl.run_multiline
Mapdl.input_strings
Mapdl.save_selection
Mapdl.scalar_param
Mapdl.screenshot
Mapdl.set_log_level
Mapdl.version
Mapdl.thermal_result
Mapdl.use_vtk
Mapdl.file_type_for_plots
Mapdl.version


Constants
Expand All @@ -57,40 +96,17 @@ Constants
.. autosummary::
:toctree: _autosummary

mapdl_grpc.channel_state
mapdl_grpc.check_status
mapdl_grpc.connection
mapdl_grpc.download_result
mapdl_grpc.ip
mapdl_grpc.is_local
mapdl_grpc.MapdlGrpc.download
mapdl_grpc.MapdlGrpc.download_project
mapdl_grpc.MapdlGrpc.list_error_file
mapdl_grpc.MapdlGrpc.list_files
mapdl_grpc.MapdlGrpc.mute
mapdl_grpc.MapdlGrpc.upload
mapdl_grpc.port


``Information`` class attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: ansys.mapdl.core.information

.. autosummary::
:toctree: _autosummary

Information.product
Information.mapdl_version
Information.pymapdl_version
Information.products
Information.preprocessing_capabilities
Information.aux_capabilities
Information.solution_options
Information.post_capabilities
Information.title
Information.titles
Information.stitles
Information.units
Information.scratch_memory_status
Information.database_status
Information.config_values
Information.global_status
Information.job_information
Information.model_information
Information.boundary_condition_information
Information.routine_information
Information.solution_options_configuration
Information.load_step_options
Loading