diff --git a/doc/source/how-to/packaging.rst b/doc/source/how-to/packaging.rst index bcfdf4317..80e2d02ea 100644 --- a/doc/source/how-to/packaging.rst +++ b/doc/source/how-to/packaging.rst @@ -363,6 +363,15 @@ optional dependencies: extras to replicate similar behavior. - Avoid specifying development-only dependencies in the main dependencies. + .. warning:: + + If you are using extras as a workaround for dependency groups, be cautious that testing and + documentation dependencies should not be user facing. Therefore, do not include inside the + ``all`` target any of the testing or documentation dependencies (that is, ``pytest``, ``pytest-cov``, + ``sphinx``, ``sphinx-autoapi``, and similar). You should create a separate extra (``dev``, + ``tests``, ``doc``, or similar) for such dependencies. + + Making dependencies optional allows users to install lightweight versions of your PyAnsys library. This is especially useful for users who are not interested in certain features or who are using the library in a headless environment. It also @@ -382,6 +391,8 @@ A migration example of a library from not having a ``graphics`` target to having is shown below: - `PyAnsys Geometry - 1782 - feat: separate graphics target `_ +- `PyMAPDL - 3820 - fix: Optional graphics dependency `_ +- `PyMAPDL Reader - 567 - feat: separate graphics target `_ Examples of PyAnsys projects that have these optional dependencies are: @@ -389,8 +400,6 @@ Examples of PyAnsys projects that have these optional dependencies are: - `PyAnsys Geometry targets `_ - `PyACP targets `_ -.. TODO: Add more examples of PyAnsys projects that have these optional dependencies. - Dependabot ---------- @@ -481,7 +490,7 @@ Dependabot allows for two different types of updates: * **Dependabot security updates**: Automated pull requests that help update dependencies with known vulnerabilities. * **Dependabot version updates**: Automated pull requests that keep dependencies updated, - even when they don’t have any vulnerabilities. To check the status of version updates, + even when they don't have any vulnerabilities. To check the status of version updates, navigate to the **Insights** tab of your repository and then select **Dependency Graph** and **Dependabot**.