EPIC: Expand and Consolidate documentation

seanpearsonuk commented 7 months ago

[] ensure that documentation fully covers all PyFluent-* features
[] maintain cheatsheet properly so that it always gives a full, broad and up-to-date summary over PyFluent functionality
[] link to the cheatsheet from the main doc OR rather just start from scratch!
[] optionally create a PyFluent-visualization cheatsheet Good example: https://matplotlib.org/cheatsheets/_images/cheatsheets-1.png Specific, additional issues:
[] add a user-guide section, fully detailing what all the session types are #2956
[] Consider moving much doc from API Ref to user guide #2957
[] reconsider each launch_fluent() snippet where the mode could be left at the default
[] API reference simply exposes the public interfaces based on the package hierarchy #3109

mkundu1 commented 6 months ago

Apart from the documentation code, the following dcumentation aspects of Python code should be looked into:

~~1. Missing or incomplete docstrings~~

Missing typehints ~~3. Missing exception specification (search for disable=missing-raises-doc in code)~~

A lot of these can be captured by enbaling linter options (e.g. enabling missing-param-doc in the docparams pylint extension shows all missing parameter declaration).

seanpearsonuk commented 5 months ago

@mkundu1 @prmukherj @hpohekar Let's dicuss this today.

seanpearsonuk commented 5 months ago

@hpohekar to look into 1 and 3 above

mkundu1 commented 5 months ago

ansys / pyfluent

EPIC: Expand and Consolidate documentation #2412