Include asynchronous function into the PyFluent documentation

[RobPasMue]

🐞 Problem

It has been identified that there is an upcoming utils module function (asynchronous, within async_execution.py) whose scope has been broaden and is now made public. It is important that the documentation for this function/file is therefore indexed in the PyFluent documentation. At the moment, no utils module classes or functions are being indexed.

💡 Proposed solution

Once PR #280 is merged with the main branch, a new branch should be open to include into the Sphynx configuration files a new utils.rst to be indexed. This file should refer to the newly created asynchronous function.

Proposed for evaluation and review: @seanpearsonuk @mkundu1

[dnwillia-work]

Yes, and perhaps not all of the utils package should be public either. See #109.

[RobPasMue]

Yes, and perhaps not all of the utils package should be public either. See #109.

That is true, if there are some implementations/functionalities which are not intended to be used by end users, they should be made private wherever possible. The way to do this can be discussed (as proposed in #109). I would have to look into the best way to do this though, if you agree =).

[seanpearsonuk]

@RobPasMue Please go ahead and make the changes as you consider appropriate. Thanks.

[RobPasMue]

After looking at #300, a reorganization of the utils package could take place in the PR associated to that issue. Maybe it is best to postpone the reorganization of the package until the discussion on #300 is clear. Thus, in this issue we would only tackle showing the docs for the asynchronous function. Do you agree @seanpearsonuk @dnwillia-work?

[seanpearsonuk]

@RobPasMue Yes, please go ahead with the task specific to the documentation.