Ability to navigate the Settings API doc

[seanpearsonuk]

https://fluentdocs.pyansys.com/api/core/solver/settings.html is difficult to navigate.

It is not immediately obvious that the API is rooted at an explicit root object. A link to the root object is provided only at the end of the page referenced by the above link.

The table of contents includes things like c2. Are these names just an artifact of the mechanism to facilitate documentation of the nested hierarchy? For instance this is the page for c2: https://fluentdocs.pyansys.com/api/core/solver/_autosummary/settings/c2.html, which is difficult to comprehend.

Clicking around, one finds pages like this https://fluentdocs.pyansys.com/api/core/solver/_autosummary/settings/phase_24.html#phase-24 for phase-24, which is not in the contents.

It would be timely to resolve this now as @RobPasMue is applying the same mechanism in order to document the TUI API.

cc: @dnwillia-work @mkundu1 @V-Dandekar @h-krishnan

[V-Dandekar]

@seanpearsonuk
Maybe we can move the link to root object in "Top-level Objects" section.

The names you see in table of contents are class names coming from fluent. (Except the child object types which are named as namedObject_child e.g. contour_child)

Which leads to your next point where phase-24 doesn't seem to be part of table of contents. Well it is part of table of contents under name "phase" (Since that is the class name.) You can see it highlighted. Phase-24 is the module name (file name) since there are multiple phase classes. Maybe we can try to enhance table of content name by including both class and module name

[seanpearsonuk]

@RobPasMue will be looking into resolving this concretely for the documentation of all the APIs.

[mkundu1]

The name c2 is coming from Fluent, so it is not an issue. We're planning to document how to browse/use the documentation for the remaining issues for the current release (we'll move the root object link to the top/side).