Hidden features are documented in PySystemCoupling API documentation

[ochernuk]

🔍 Before submitting the issue

• I have searched among the existing issues
• I am using a Python virtual environment

🐞 Description of the bug

All hidden features are documented in PySystemCoupling API Reference. For example, here:

https://systemcoupling.docs.pyansys.com/version/0.4/api/core/settings/_autosummary/api/analysis_control.html#analysis-control

Options like unmapped_value_options are hidden behind an alpha flag and should be omitted from the documentation.

📝 Steps to reproduce

Open this page and see hidden features being documented:

https://systemcoupling.docs.pyansys.com/version/0.3/api/core/settings/_autosummary/api/unmapped_value_options.html

💻 Which operating system are you using?

Windows

📀 Which ANSYS version are you using?

24.1

🐍 Which Python version are you using?

3.10

📦 Installed packages

n/a

[iboyd-ansys]

This could be quite tricky for the following reasons:

1. We don't have a straightforward way to identify which settings are feature-dependent.
2. There is no guarantee that the dependency is static. Sometimes a setting is non-beta in one context and beta in another.
3. There is not even a guarantee that an "alpha" setting is directly identified as such via a check, because it can be something that depends on something else that is alpha. We are, however, able statically to identify potential dependencies by following the static check dependency graph. So, in practice, what we do is to identify settings statically that might be alpha/beta-dependent (directly or indirectly), and then at run time probe their actual dependency by flipping the alpha/beta check off and seeing if it remains available.
4. Documentation is automatically generated from classes that are themselves generated from the datamodel metadata. There is probably a way to get it to exclude certain members if we can find a way to identify them.
5. Whatever way we do this, it will need changes both in SystemCoupling and PySystemCoupling.

An option might be to do something like we do for the commands and semi-manually generate some additional metadata. We could maybe do a best-guess generation of a list of settings that are to be excluded because they are alpha based on a simplified analysis, but allow it to be hand-edited.

[pyansys-automation]

Hello @iboyd-ansys!
This issue has been open for over a year and has had no updates in the past 8 months. If it is still relevant, please provide an update. Otherwise, consider closing it to help keep the issue tracker clean.

If this issue needs to remain open, please comment below with @pyansys-automation never close issue to prevent it from being automatically closed.

If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form.

[iboyd-ansys]

Tricky to fix as per discussion above. Will revisit.