Skip to content

Commit

Permalink
Fix doc generation (#1343)
Browse files Browse the repository at this point in the history
* Fix server_factory.py docstring

Signed-off-by: paul.profizi <paul.profizi@ansys.com>

* Bump ansys_sphinx_theme to 0.13.0

Signed-off-by: paul.profizi <paul.profizi@ansys.com>

---------

Signed-off-by: paul.profizi <paul.profizi@ansys.com>
  • Loading branch information
PProfizi authored Jan 9, 2024
1 parent 39ef6e0 commit 909eaa8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion requirements/requirements_docs.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ansys_sphinx_theme==0.12.3
ansys_sphinx_theme==0.13.0
enum-tools[sphinx]==0.9.0.post1
graphviz==0.20.1
imageio==2.28.0
Expand Down
11 changes: 6 additions & 5 deletions src/ansys/dpf/core/server_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,11 +278,12 @@ def get_default_server_config(
server_lower_than_or_equal_to_0_3: bool = False, docker_config: DockerConfig = None
):
"""Returns the default configuration depending on the server version.
- if ansys.dpf.core.SERVER_CONFIGURATION is not None, then this variable is taken
- if server_lower_than_or_equal_to_0_3 is True, then LegacyGrpcServer is taken
- DPF_SERVER_TYPE environment variable is set to ``INPROCESS``, ``GRPC``, ``LEGACYGRPC``,
then this variable is taken
else DEFAULT_COMMUNICATION_PROTOCOL and DEFAULT_LEGACY is taken.
- if ansys.dpf.core.SERVER_CONFIGURATION is not None, then this variable is taken
- if server_lower_than_or_equal_to_0_3 is True, then LegacyGrpcServer is taken
- if DPF_SERVER_TYPE environment variable is set to ``INPROCESS``, ``GRPC``, or
``LEGACYGRPC``, then this variable is taken
- else DEFAULT_COMMUNICATION_PROTOCOL and DEFAULT_LEGACY are used.
Raises
------
Expand Down

0 comments on commit 909eaa8

Please sign in to comment.