Skip to content

Commit 0337a4c

Browse files
authored
Add links for doc and cheat sheet (#1113)
* Add links for doc and cheat sheet * Fix bad format for link
1 parent 7b246ed commit 0337a4c

File tree

2 files changed

+48
-8
lines changed

2 files changed

+48
-8
lines changed

README.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[![cov](https://codecov.io/gh/ansys/pydpf-core/branch/master/graph/badge.svg)](https://codecov.io/gh/ansys/pydpf-core)
1111
[![codacy](https://app.codacy.com/project/badge/Grade/61b6a519aea64715ad1726b3955fcf98)](https://www.codacy.com/gh/ansys/pydpf-core/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ansys/pydpf-core&utm_campaign=Badge_Grade)
1212

13-
The Data Processing Framework (DPF) provides numerical simulation
13+
Ansys Data Processing Framework (DPF) provides numerical simulation
1414
users and engineers with a toolbox for accessing and transforming simulation
1515
data. With DPF, you can perform complex preprocessing or postprocessing of
1616
large amounts of simulation data within a simulation workflow.
@@ -27,8 +27,8 @@ The latest version of DPF supports Ansys solver result files for:
2727
- Fluent (`.cas/dat.h5`, `.flprj`)
2828
- CFX (`.cad/dat.cff`, `.flprj`)
2929

30-
See the `PyDPF-Core main page <https://dpf.docs.pyansys.com/version/stable/index.html>`_
31-
for more information on compatibility.
30+
For more information on compatibility, see the `main page <https://dpf.docs.pyansys.com/version/stable/index.html>`_
31+
of the PDF-Core documentation.
3232

3333
Using the many DPF operators that are available, you can manipulate and
3434
transform this data. You can also chain operators together to create simple
@@ -47,12 +47,30 @@ The ``ansys.dpf.core`` package provides a Python interface to DPF, enabling
4747
rapid postprocessing of a variety of Ansys file formats and physics solutions
4848
without ever leaving the Python environment.
4949

50-
## Documentation
50+
## Documentation and issues
5151

52-
Visit the [DPF-Core Documentation](https://dpfdocs.pyansys.com) for
53-
comprehensive information on this library. See the
54-
[Examples](https://dpfdocs.pyansys.com/version/stable/examples/index.html)
55-
for how-to information.
52+
Documentation for the latest stable release of PyPDF-Core is hosted at
53+
[DPF-Core documentation](https://dpf.docs.pyansys.com/version/stable/).
54+
55+
In the upper right corner of the documentation's title bar, there is an option for switching from
56+
viewing the documentation for the latest stable release to viewing the documentation for the
57+
development version or previously released versions.
58+
59+
In the upper right corner of the documentation's title bar, there is an option for switching from
60+
viewing the documentation for the latest stable release to viewing the documentation for the
61+
development version or previously released versions.
62+
63+
You can also [view](https://cheatsheets.docs.pyansys.com/pydpf-core_cheat_sheet.png) or
64+
[download](https://cheatsheets.docs.pyansys.com/pydpf-core_cheat_sheet.pdf) the
65+
PyDPF-Core cheat sheet. This one-page reference provides syntax rules and commands
66+
for using PyDPF-Core.
67+
68+
On the [PyDPF-Core Issues](https://github.com/ansys/pydpf-core/issues) page,
69+
you can create issues to report bugs and request new features. On the
70+
[PyDPF-Core Discussions](https://github.com/ansys/pydpf-core/discussions) page or the {Discussions](https://discuss.ansys.com/)
71+
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
72+
73+
To reach the project support team, email [[email protected]](mailto:[email protected]).
5674

5775
## Installation
5876

docs/source/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,28 @@ It is independent of the Ansys installer.
153153

154154
- `C++ solver reader plugin <https://astonishing-hyacinth-e64.notion.site/How-to-write-a-new-solver-reader-as-a-DPF-s-plugin-bd2d2a3cf51f47ef9e70df45d64f89cb>`_
155155

156+
Documentation and issues
157+
------------------------
158+
Documentation for the latest stable release of PyDPF-Core is hosted at `PyDPF-Core documentation
159+
<https://dpf.docs.pyansys.com/version/stable/>`_.
160+
161+
In the upper right corner of the documentation's title bar, there is an option for switching from
162+
viewing the documentation for the latest stable release to viewing the documentation for the
163+
development version or previously released versions.
164+
165+
You can also `view <https://cheatsheets.docs.pyansys.com/pydpf-core_cheat_sheet.png>`_ or
166+
`download <https://cheatsheets.docs.pyansys.com/pydpf-core_cheat_sheet.pdf>`_ the
167+
PyDPF-Core cheat sheet. This one-page reference provides syntax rules and commands
168+
for using PyDPF-Core.
169+
170+
On the `PyDPF-Core Issues <https://github.com/ansys/pydpf-core/issues>`_ page,
171+
you can create issues to report bugs and request new features. On the `PyDPF-Core Discussions
172+
<https://github.com/ansys/pydpf-core/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
173+
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
174+
175+
To reach the project support team, email `[email protected] <[email protected]>`_.
176+
177+
156178
- :ref:`user_guide_custom_operators`
157179

158180

0 commit comments

Comments
 (0)