docs: Document all environment variable usage in PyFluent (#3460)

doc/source/contributing/environment_variables.rst

@@ -0,0 +1,62 @@
+.. _ref_environment_variables:
+
+=====================
+Environment Variables
+=====================
+
+Following is a list of environment variables that can be set to control various aspects of PyFluent.
+
+.. list-table::
+    :header-rows: 1
+
+    * - Variable
+      - Description
+    * - ANSYSLMD_LICENSE_FILE
+      - Specifies the license server for Fluent.
+    * - AWP_ROOT<NNN>
+      - Specifies the Fluent root directory for the version vNNN while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - FLUENT_CONTAINER_IMAGE
+      - Specifies the full Docker image name including tag while starting a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - FLUENT_IMAGE_NAME
+      - Specifies the Docker image name while starting a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - FLUENT_IMAGE_TAG
+      - Specifies the Docker image tag while starting a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_CONTAINER_MOUNT_SOURCE
+      - Specifies the host path which is mounted inside the container while starting a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_CONTAINER_MOUNT_TARGET
+      - Specifies the path inside the container where the host path is mounted while starting a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_FLUENT_DEBUG
+      - Starts Fluent in debug mode while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_FLUENT_IP
+      - Specifies the IP address of the Fluent server in :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>`.
+    * - PYFLUENT_FLUENT_PORT
+      - Specifies the port of the Fluent server in :func:`connect_to_fluent() <ansys.fluent.core.launcher.launcher.connect_to_fluent>`.
+    * - PYFLUENT_FLUENT_ROOT
+      - Specifies the Fluent root directory while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_GRPC_LOG_BYTES_LIMIT
+      - Specifies the length of gRPC logging messages. Set to 0 to disable the limit.
+    * - PYFLUENT_LAUNCH_CONTAINER
+      - Starts a Fluent container in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_LOGGING
+      - Enabled PyFluent logging and specifies the logging level. Possible values are ``DEBUG``, ``INFO``, ``WARNING``, ``ERROR``, and ``CRITICAL``.
+    * - PYFLUENT_NO_FIX_PARAMETER_LIST_RETURN
+      - Disables the return value fix for the parameter list command in settings API.
+    * - PYFLUENT_SHOW_SERVER_GUI
+      - Shows the Fluent GUI while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - PYFLUENT_SKIP_API_UPGRADE_ADVICE
+      - Disables printing of TUI to settings API upgrade advice.
+    * - PYFLUENT_SKIP_EXAMPLES_DOC
+      - Skips the generation of examples documentation.
+    * - PYFLUENT_TIMEOUT_FORCE_EXIT
+      - Enables force exit while exiting a Fluent session and specifies the timeout in seconds.
+    * - PYFLUENT_WATCHDOG_DEBUG
+      - Enables debugging for the PyFluent watchdog process.
+    * - PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR
+      - Raises exception when error occurs in the PyFluent watchdog process.
+    * - REMOTING_PORTS
+      - Specifies the port range for the Fluent server while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+        The format is ``<start_port>/portspan=<port_span>``.
+    * - REMOTING_SERVER_ADDRESS
+      - Specifies the IP address of the Fluent server while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.
+    * - SERVER_INFO_DIR
+      - Specifies the directory where the server-info file will be created while launching Fluent in :func:`launch_fluent() <ansys.fluent.core.launcher.launcher.launch_fluent>`.

doc/source/contributing.rst → doc/source/contributing/index.rst

@@ -3,6 +3,13 @@
 ========================
 Contributing to PyFluent
 ========================
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   environment_variables
+
 General guidance on contributing to a PyAnsys library appears in the
 `Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
 in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar with

doc/source/index.rst

@@ -9,7 +9,7 @@ PyFluent documentation |version|
    user_guide/index
    api/index
    examples/index
-   contributing
+   contributing/index
 
 
 Welcome to PyFluent documentation