From df02cc0bd60ed036eaad7621ac62c523aa692908 Mon Sep 17 00:00:00 2001 From: Kathy Pippert Date: Thu, 10 Aug 2023 15:19:26 -0400 Subject: [PATCH] Add links for doc and cheat sheet --- README.rst | 34 +++++++++++++++++++++++----------- doc/source/index.rst | 21 ++++++++++++++++----- 2 files changed, 39 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 3ec65e9ce..e7b8b2891 100644 --- a/README.rst +++ b/README.rst @@ -35,22 +35,34 @@ PyDynamicReporting Overview -------- -The ``pydynamicreporting`` repository contains the Python client library for -Ansys Dynamic Reporting, previously documented as `Nexus`_. Ansys Dynamic -Reporting is a service for pushing items of many types, including images, text, -3D scenes, and tables, into a database, where you can keep them organized and -create dynamic reports from them. When you use PyDynamicReporting to connect to -an instance of Ansys Dynamic Reporting, you have a Pythonic way of accessing all -capabilities of Ansys Dynamic Reporting. +PyDynamicReporting is the Python client library for Ansys Dynamic Reporting, +previously documented as `Nexus`_. Ansys Dynamic Reporting is a service for +pushing items of many types, including images, text, 3D scenes, and tables, +into a database, where you can keep them organized and create dynamic reports +from them. When you use PyDynamicReporting to connect to an instance of +Ansys Dynamic Reporting, you have a Pythonic way of accessing all capabilities +of Ansys Dynamic Reporting. Documentation and issues ------------------------ -For comprehensive information on PyDynamicReporting, see the latest release -`documentation `_. +Documentation for the latest stable release of PyDynamicReporting is hosted at +`PyDynamicReporting documentation `_. + +In the upper right corner of the documentation's title bar, there is an option +for switching from viewing the documentation for the latest stable release +to viewing the documentation for the development version or previously +released versions. + +You can also `view `_ or +`download `_ the +PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands +for using PyDynamicReporting. On the `PyDynamicReporting Issues `_ -page, you can create issues to submit questions, report bugs, and request new -features. This is the best place to post questions and code. +page, you can create issues to report bugs and request new features. On the `Discussions `_ +page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback. + +To reach the project support team, email `pyansys.core@ansys.com `_. Installation ------------ diff --git a/doc/source/index.rst b/doc/source/index.rst index f152dc341..5b65b230b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,15 +37,26 @@ a Python client library that allows you to start and connect to an Ansys Dynamic service and control the database and reports. It also provides you with quick access to web components so that you can easily embed items or reports in other apps. - Documentation and issues ------------------------ -For comprehensive information on PyDynamicReporting, see the latest release -`documentation `_. +Documentation for the latest stable release of PyDynamicReporting is hosted at +`PyDynamicReporting documentation `_. + +In the upper right corner of the documentation's title bar, there is an option +for switching from viewing the documentation for the latest stable release +to viewing the documentation for the development version or previously +released versions. + +You can also `view `_ or +`download `_ the +PyDynamicReporting cheat sheet. This one-page reference provides syntax rules and commands +for using PyDynamicReporting. On the `PyDynamicReporting Issues `_ -page, you can create issues to submit questions, report bugs, and request new -features. This is the best place to post questions and code. +page, you can create issues to report bugs and request new features. On the `Discussions `_ +page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback. + +To reach the project support team, email `pyansys.core@ansys.com `_. License -------