How-to
======

This section describes how to create effective and efficient Python libraries
for interfacing with Ansys products and services. It also explains how apps
and complex services expose functionalities such as logging, data transfer,
and app APIs.

.. grid:: 3

    .. grid-item-card:: :fas:`fa-regular fa-screwdriver-wrench` Environment setup
      :link: setting-up
      :link-type: doc
      :padding: 2 2 2 2

      How to set up a development environment.

    .. grid-item-card:: :fas:`fa-solid fa-code-compare` Python versions
      :link: supporting-python-versions
      :link-type: doc
      :padding: 2 2 2 2

      How to know which Python versions to support.

    .. grid-item-card:: :fas:`fa-solid fa-people-group` Contributing
      :link: contributing
      :link-type: doc
      :padding: 2 2 2 2

      How to contribute to a PyAnsy library.

    .. grid-item-card:: :fas:`fa-solid fa-box-open` Packaging
      :link: packaging
      :link-type: doc
      :padding: 2 2 2 2

      How to package a PyAnsys library.

    .. grid-item-card:: :fas:`fa-solid fa-cubes` gRPC API packages
      :link: grpc-api-packages
      :link-type: doc
      :padding: 2 2 2 2

      How to integrate gRPC in PyAnsys packages.

    .. grid-item-card:: :fas:`fa-solid fa-bars-staggered` Logging
      :link: logging
      :link-type: doc
      :padding: 2 2 2 2

      How to write to PyAnsys library logs.

    .. grid-item-card:: :fas:`fa-solid fa-file` Documenting
      :link: documenting
      :link-type: doc
      :padding: 2 2 2 2

      How to write and style your documentation.

    .. grid-item-card:: :fas:`fa-solid fa-flask-vial` Testing
      :link: testing
      :link-type: doc
      :padding: 2 2 2 2

      How to perform code testing and check coverage.

    .. grid-item-card:: :fas:`fa-solid fa-code-merge` Continuous integration
      :link: continuous-integration
      :link-type: doc
      :padding: 2 2 2 2

      How to use GitHub Actions for continuous integration.

    .. grid-item-card:: :fas:`fa-solid fa-upload` Releasing and publishing
      :link: releasing
      :link-type: doc
      :padding: 2 2 2 2

      How to release and publish a PyAnsys package.

    .. grid-item-card:: :fas:`fa-solid fa-umbrella` Repository protection
      :link: repository-protection
      :link-type: doc
      :padding: 2 2 2 2

      How to handle sensitive information.

    .. grid-item-card:: :fas:`fa-solid fa-server` DNS configuration
      :link: dns-configuration
      :link-type: doc
      :padding: 2 2 2 2

      How to configure and protect your DNS.

    .. grid-item-card:: :fas:`fa-solid fa-circle-nodes` Product compatibility
      :link: compatibility
      :link-type: doc
      :padding: 2 2 2 2

      How to handle compatibility issues.


.. toctree::
   :maxdepth: 3
   :hidden:

   setting-up
   supporting-python-versions
   contributing
   packaging
   grpc-api-packages
   logging
   documenting
   testing
   continuous-integration
   releasing
   repository-protection
   dns-configuration
   compatibility