show_skill

ansys.mapdl.core.cli.skills.show_skill(skill_name, skills_dir=None)

Return the full SKILL.md content of a bundled skill.

Parameters:

skill_namestr

Skill identifier, as reported by list_skills().

skills_dirpathlib.Path, optional

Directory holding one sub-directory per skill. Defaults to the directory bundled with the package.

Returns:

str

Content of the SKILL.md file, frontmatter included.

Raises:

UnknownSkillError

When skill_name is not bundled with PyMAPDL.

Return type:

str

Examples

>>> from ansys.mapdl.core.cli.skills import show_skill
>>> print(show_skill("pymapdl-cli"))