Skip to content

Commit aafb5c7

Browse files
authored
Add links for doc and cheat sheet (#35)
1 parent 381c156 commit aafb5c7

File tree

2 files changed

+39
-16
lines changed

2 files changed

+39
-16
lines changed

README.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,34 @@ PyDynamicReporting
3535

3636
Overview
3737
--------
38-
The ``pydynamicreporting`` repository contains the Python client library for
39-
Ansys Dynamic Reporting, previously documented as `Nexus`_. Ansys Dynamic
40-
Reporting is a service for pushing items of many types, including images, text,
41-
3D scenes, and tables, into a database, where you can keep them organized and
42-
create dynamic reports from them. When you use PyDynamicReporting to connect to
43-
an instance of Ansys Dynamic Reporting, you have a Pythonic way of accessing all
44-
capabilities of Ansys Dynamic Reporting.
38+
PyDynamicReporting is the Python client library for Ansys Dynamic Reporting,
39+
previously documented as `Nexus`_. Ansys Dynamic Reporting is a service for
40+
pushing items of many types, including images, text, 3D scenes, and tables,
41+
into a database, where you can keep them organized and create dynamic reports
42+
from them. When you use PyDynamicReporting to connect to an instance of
43+
Ansys Dynamic Reporting, you have a Pythonic way of accessing all capabilities
44+
of Ansys Dynamic Reporting.
4545

4646
Documentation and issues
4747
------------------------
48-
For comprehensive information on PyDynamicReporting, see the latest release
49-
`documentation <https://dynamicreporting.docs.pyansys.com>`_.
48+
Documentation for the latest stable release of PyDynamicReporting is hosted at
49+
`PyDynamicReporting documentation <https://dynamicreporting.docs.pyansys.com/version/stable/>`_.
50+
51+
In the upper right corner of the documentation's title bar, there is an option
52+
for switching from viewing the documentation for the latest stable release
53+
to viewing the documentation for the development version or previously
54+
released versions.
55+
56+
You can also `view <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.png>`_ or
57+
`download <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.pdf>`_ the
58+
PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands
59+
for using PyDynamicReporting.
5060

5161
On the `PyDynamicReporting Issues <https://github.com/ansys/pydynamicreporting/issues>`_
52-
page, you can create issues to submit questions, report bugs, and request new
53-
features. This is the best place to post questions and code.
62+
page, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_
63+
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
64+
65+
To reach the project support team, email `[email protected] <[email protected]>`_.
5466

5567
Installation
5668
------------

doc/source/index.rst

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,26 @@ a Python client library that allows you to start and connect to an Ansys Dynamic
3737
service and control the database and reports. It also provides you with quick access to web
3838
components so that you can easily embed items or reports in other apps.
3939

40-
4140
Documentation and issues
4241
------------------------
43-
For comprehensive information on PyDynamicReporting, see the latest release
44-
`documentation <https://dynamicreporting.docs.pyansys.com>`_.
42+
Documentation for the latest stable release of PyDynamicReporting is hosted at
43+
`PyDynamicReporting documentation <https://dynamicreporting.docs.pyansys.com/version/stable/>`_.
44+
45+
In the upper right corner of the documentation's title bar, there is an option
46+
for switching from viewing the documentation for the latest stable release
47+
to viewing the documentation for the development version or previously
48+
released versions.
49+
50+
You can also `view <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.png>`_ or
51+
`download <https://cheatsheets.docs.pyansys.com/pydynamicreporting_cheat_sheet.pdf>`_ the
52+
PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands
53+
for using PyDynamicReporting.
4554

4655
On the `PyDynamicReporting Issues <https://github.com/ansys/pydynamicreporting/issues>`_
47-
page, you can create issues to submit questions, report bugs, and request new
48-
features. This is the best place to post questions and code.
56+
page, you can create issues to report bugs and request new features. On the `Discussions <https://discuss.ansys.com/>`_
57+
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.
58+
59+
To reach the project support team, email `[email protected] <[email protected]>`_.
4960

5061
License
5162
-------

0 commit comments

Comments
 (0)