Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links for doc and cheat sheet #2235

Merged
merged 5 commits into from
Aug 10, 2023
Merged

Add links for doc and cheat sheet #2235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
93f68a9
Add links for doc and cheat sheet
PipKat Aug 9, 2023
2ad7dd6
Make revisions based on German's feedback
PipKat Aug 9, 2023
d8570b5
Merge branch 'main' into doc/add_doc_cheat_sheet_links
germa89 Aug 10, 2023
37e1848
Using same link/descriptiont in readme.
germa89 Aug 10, 2023
d7e5873
Fixing title structure.
germa89 Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,24 @@ or in batch mode on Windows, Linux, and even Mac OS.

Documentation and issues
------------------------
For more information, see the `Documentation <https://mapdl.docs.pyansys.com>`_ page.
For some examples, see the `Examples gallery <https://mapdl.docs.pyansys.com/version/stable/examples/index.html>`_.
Documentation for the latest stable release of PyMAPDL is hosted at `PyMAPDL Documentation
<https://mapdl.docs.pyansys.com>`_.

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.

Feel free to post issues and other questions at `PyMAPDL Issues
<https://github.com/pyansys/pymapdl/issues>`_. This is the best place
to post questions and code.
You can also `view <https://cheatsheets.docs.pyansys.com/pymapdl_cheat_sheet.png>`_ or
`download <https://cheatsheets.docs.pyansys.com/pymapdl_cheat_sheet.pdf>`_ the
PyMAPDL cheat sheet. This one-page reference provides syntax rules and commands
for using PyMAPDL.
PipKat marked this conversation as resolved.
Show resolved Hide resolved

On the `PyMAPDL Issues <https://github.com/ansys/pymapdl/issues>`_ page,
you can create issues to report bugs and request new features. On the `PyMAPDL Discussions
<https://github.com/ansys/pymapdl/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email `[email protected] <[email protected]>`_.

Project transition - legacy support
-----------------------------------
Expand Down
23 changes: 20 additions & 3 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,28 @@ You can even plot directly from the Python environment with:

Element plot from MAPDL using ``PyMAPDL`` and ``vtk``

For a full listing of PyMAPDL features, see the
:ref:`ref_user_guide`.
Documentation and issues
------------------------
Documentation for the latest stable release of PyMAPDL is hosted at `PyMAPDL documentation
<https://mapdl.docs.pyansys.com/version/stable/>`_.

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 <https://cheatsheets.docs.pyansys.com/pymapdl_cheat_sheet.png>`_ or
`download <https://cheatsheets.docs.pyansys.com/pymapdl_cheat_sheet.pdf>`_ the
PyMAPDL cheat sheet. This one-page reference provides syntax rules and commands
for using PyMAPDL.

On the `PyMAPDL Issues <https://github.com/ansys/pymapdl/issues>`_ page,
you can create issues to report bugs and request new features. On the `PyMAPDL Discussions
<https://github.com/ansys/pymapdl/discussions>`_ page or the `Discussions <https://discuss.ansys.com/>`_
page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email `[email protected] <[email protected]>`_.

Project index
*************
-------------

* :ref:`genindex`