Skip to content

Adding troubleshooting section #1423

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.

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

Merged
merged 13 commits into from
Sep 2, 2022
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ env:
# You should go up in number, if you go down (or repeat a previous value)
# you might end up reusing a previous cache if it haven't been deleted already.
# It applies 7 days retention policy by default.
RESET_PIP_CACHE: 4
RESET_EXAMPLES_CACHE: 4
RESET_DOC_BUILD_CACHE: 4
RESET_AUTOSUMMARY_CACHE: 4
RESET_PIP_CACHE: 5
RESET_EXAMPLES_CACHE: 5
RESET_DOC_BUILD_CACHE: 5
RESET_AUTOSUMMARY_CACHE: 5
PACKAGE_NAME: PyMAPDL

concurrency:
Expand Down
34 changes: 0 additions & 34 deletions doc/source/api/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _ref_contributing:

============
Contributing
============
====================
Contributing and API
====================

Overall guidance on contributing to a PyAnsys library appears in the
`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
Expand All @@ -12,8 +13,10 @@ contribute to PyMAPDL.

The following contribution information is specific to PyMAPDL.


Cloning the PyMAPDL Repository
------------------------------
==============================

Run this code to clone and install the latest version of PyMAPDL in development mode:

.. code::
Expand All @@ -25,7 +28,8 @@ Run this code to clone and install the latest version of PyMAPDL in development


Posting Issues
--------------
==============

Use the `PyMAPDL Issues <https://github.com/pyansys/pymapdl/issues>`_
page to submit questions, report bugs, and request new features. When possible, we
recommend that you use these issue templates:
Expand All @@ -38,7 +42,8 @@ If your issue does not fit into one of these categories, create your own issue.
To reach the project support team, email `[email protected] <[email protected]>`_.

Viewing PyMAPDL Documentation
-----------------------------
=============================

Documentation for the latest stable release of PyMAPDL is hosted at
`PyMAPDL Documentation <https://mapdldocs.pyansys.com>`_.

Expand All @@ -47,7 +52,8 @@ Documentation for the latest development version, which tracks the
This version is automatically kept up to date via GitHub actions.

Testing MAPDL
-------------
=============

If you do not have MAPDL installed locally but still want to run the
unit testing, you must set up the following environment variables.

Expand All @@ -72,7 +78,8 @@ MAPDL service by default when the ``launch_mapdl`` function is used.


Code Style
----------
==========

PyMAPDL follows PEP8 standard as outlined in the `PyAnsys Development Guide
<https://dev.docs.pyansys.com>`_ and implements style checking using
`pre-commit <https://pre-commit.com/>`_.
Expand All @@ -94,3 +101,38 @@ This way, it's not possible for you to push code that fails the style checks. Fo
isort....................................................................Passed
flake8...................................................................Passed
codespell................................................................Passed


.. _ref_index_api:

API Reference
=============
This section gives an overview of the API of several public PyMAPDL
classes, functions, and attributes.

These methods may include some MAPDL commands but are generally
specific to pymapdl specific methods and classes (i.e. methods that
extend existing MAPDL methods in a pythonic manner). For classic
MAPDL commands mapped to PyMAPDL, see :ref:`ref_mapdl_commands`.


.. toctree::
:maxdepth: 2
:hidden:

commands
database
geometry
helper
inline
logging
mapdl
math
mesh
parameters
plotting
pool
post
solution
xpl

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ getting a licensed copy of Ansys.
versioning
docker
using_julia
faq
wsl

************
Expand Down
Loading