Skip to content

Commit effd27e

Browse files
authored
Add info to explain switching of doc versions (#256)
Update main index.rst file with minor edits Note: The display links to other topics should use the same title as the topic. This is a Google developer doc style guideline. Users can be confident that the have been taked to the correct place.
1 parent c68d95f commit effd27e

File tree

2 files changed

+30
-16
lines changed

2 files changed

+30
-16
lines changed

README.rst

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ PyDPF Composites is a Python wrapper for Ansys DPF composites. It implements
3737
classes on top of DPF Composites operators and data accessors for short
3838
fiber and layered composites (layered shell and solid elements). This module
3939
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.
4243

4344
.. START_MARKER_FOR_SPHINX_DOCS
4445
@@ -73,12 +74,14 @@ familiar with the `PyAnsys Developer's Guide`_.
7374
pipx install poetry
7475
pipx install pip
7576
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>`_
8080
to manage the development environment.
8181

82+
#. Create a virtual environment and install the package with the
83+
development dependencies:
84+
8285
.. code:: bash
8386
8487
poetry install --all-extras
@@ -98,13 +101,13 @@ Test
98101

99102
The Docker container referenced in the first option is not yet publicly available.
100103

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``.
103106

104107
There are three ways to run the PyDPF Composites tests, depending on how the DPF
105108
server is started.
106109

107-
#. Run tests with a Docker container.
110+
#. Run tests with a Docker container:
108111

109112
.. code:: bash
110113
@@ -175,6 +178,17 @@ The style checks can also be configured to run automatically before each ``git c
175178
pre-commit install
176179
177180
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+
178192
.. LINKS AND REFERENCES
179193
.. _black: https://github.com/psf/black
180194
.. _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
185199
.. _pytest: https://docs.pytest.org/en/stable/
186200
.. _Sphinx: https://www.sphinx-doc.org/en/master/
187201
.. _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

doc/source/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ PyDPF Composites
1414
PyDPF Composites is a Python wrapper for Ansys DPF composites. It implements
1515
classes on top of DPF Composites operators and data accessors for short
1616
fiber and layered composites (layered shell and solid elements). This module
17-
can be used to postprocess fiber reinforced plastics and layered composites, and
17+
can be used to postprocess fiber reinforced plastics and layered composites and
1818
to implement custom failure criteria and computation.
1919

2020
.. grid:: 1 1 2 2
@@ -31,7 +31,7 @@ to implement custom failure criteria and computation.
3131
:link: examples/index
3232
:link-type: doc
3333

34-
Demonstrate the use of PyDPF Composites for various workflows.
34+
Demonstrates the use of PyDPF Composites for various workflows.
3535

3636
.. grid-item-card:: :octicon:`file-code` API reference
3737
:link: api/index
@@ -66,18 +66,18 @@ Prerequisites
6666

6767
Here are some prerequisites for PyDPF Composites:
6868

69-
- Installation of `Ansys Workbench`_ from Ansys 2023 R1 or later. For more information,
69+
- Installation of `Ansys Workbench`_ 2023 R1 or later. For more information,
7070
see `Compatibility`_ in the DPF help.
7171
- ACP model or short fiber composite model.
7272

7373
Limitations
7474
'''''''''''
7575
- Layered elements (section data) that have not been preprocessed with ACP are not supported.
76-
For information on converting legacy models, see `Import legacy models`_
77-
in the Ansys help.
76+
For information on converting legacy models, see `Import of Legacy Mechanical APDL Composite Models`_
77+
in the Ansys Help.
7878
- Only the Mechanical APDL solver is supported.
7979

8080

8181
.. _Ansys Workbench: https://download.ansys.com/Current%20Release
82-
.. _Import legacy models: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/acp_ug/acp_import_legacy_APDL_comp.html
82+
.. _Import of Legacy Mechanical APDL Composite Models: https://ansyshelp.ansys.com/account/secured?returnurl=/Views/Secured/corp/v231/en/acp_ug/acp_import_legacy_APDL_comp.html
8383
.. _Compatibility: https://dpf.docs.pyansys.com/getting_started/compatibility.html

0 commit comments

Comments
 (0)