@@ -37,8 +37,9 @@ PyDPF Composites is a Python wrapper for Ansys DPF composites. It implements
37
37
classes on top of DPF Composites operators and data accessors for short
38
38
fiber and layered composites (layered shell and solid elements). This module
39
39
can be used to postprocess fiber reinforced plastics and layered composites and
40
- to implement custom failure criteria and computation. For examples demonstrating
41
- the behavior and usage of PyDPF Composites, see `PyDPF Composites - Examples `_.
40
+ to implement custom failure criteria and computation. For information demonstrating
41
+ the behavior and usage of PyDPF Composites, see `Examples `_ in the DPF Composite
42
+ documentation.
42
43
43
44
.. START_MARKER_FOR_SPHINX_DOCS
44
45
@@ -73,12 +74,14 @@ familiar with the `PyAnsys Developer's Guide`_.
73
74
pipx install poetry
74
75
pipx install pip
75
76
pipx install tox
76
-
77
-
78
- #. Create a virtual environment and install the package with development
79
- dependencies. PyDPF Composites uses `Poetry <https://python-poetry.org >`_
77
+
78
+
79
+ PyDPF Composites uses `Poetry <https://python-poetry.org >`_
80
80
to manage the development environment.
81
81
82
+ #. Create a virtual environment and install the package with the
83
+ development dependencies:
84
+
82
85
.. code :: bash
83
86
84
87
poetry install --all-extras
@@ -98,13 +101,13 @@ Test
98
101
99
102
The Docker container referenced in the first option is not yet publicly available.
100
103
101
- Set the environment variable `ANSYSLMD_LICENSE_FILE ` to configure the licensing or pass it
102
- as argument (` --license-server=1055@mylicenseserver `) to the pytest call .
104
+ Set the environment variable `` ANSYSLMD_LICENSE_FILE ` ` to configure the licensing or pass it
105
+ as an argument to the pytest call: `` --license-server=1055@mylicenseserver `` .
103
106
104
107
There are three ways to run the PyDPF Composites tests, depending on how the DPF
105
108
server is started.
106
109
107
- #. Run tests with a Docker container.
110
+ #. Run tests with a Docker container:
108
111
109
112
.. code :: bash
110
113
@@ -175,6 +178,17 @@ The style checks can also be configured to run automatically before each ``git c
175
178
pre-commit install
176
179
177
180
181
+ View documentation
182
+ -------------------
183
+ Documentation for the latest stable release of PyDPF Composites is hosted at
184
+ `PyDPF Composites Documentation <https://composites.dpf.docs.pyansys.com/version/stable/ >`_.
185
+
186
+ In the upper right corner of the documentation's title bar, there is an option
187
+ for switching from viewing the documentation for the latest stable release
188
+ to viewing the documentation for the development version or previously
189
+ released versions.
190
+
191
+
178
192
.. LINKS AND REFERENCES
179
193
.. _black : https://github.com/psf/black
180
194
.. _flake8 : https://flake8.pycqa.org/en/latest/
@@ -185,4 +199,4 @@ The style checks can also be configured to run automatically before each ``git c
185
199
.. _pytest : https://docs.pytest.org/en/stable/
186
200
.. _Sphinx : https://www.sphinx-doc.org/en/master/
187
201
.. _tox : https://tox.wiki/
188
- .. _ PyDPF Composites - Examples : https://composites.dpf.docs.pyansys.com/dev/examples/index.html
202
+ .. _ Examples : https://composites.dpf.docs.pyansys.com/dev/examples/index.html
0 commit comments