docs: review of documenting using pymapdl on clusters (#3466)

[germa89]

This PR is just bringing the changes made in #3466 into main.

Branching

I was waiting for a doc review for #3466. This PR aimed to merge feat/passing-tight-integration-env-vars-to-MAPDL into main.

Because I was needing these changes in main but I didn't want to merge those without @PipKat approval, I did a copy of both branches....

• feat/copy-passing-tight-integration-env-vars-to-MAPDL for feat/passing-tight-integration-env-vars-to-MAPDL
• maint/main_copy for main.

Then I changed the target of #3466 to be maint/main_copy.

Then I opened another PR (#3500) which aimed to merge the copy feat/copy-passing-tight-integration-env-vars-to-MAPDL into main. And I merged.

Then I kept #3466 untouched (well, I did change the PR name to reflect the new content basically doc review). This way, the changes done (File tab in the PR) were considered still with respect to the main without #3500 which contained everything but @PipKat corrections.

Commit history

• feat: adding env vars needed for multinode

• feat: adding env vars needed for multinode

• feat: renaming hpc detection argument

• docs: adding documentation

• chore: adding changelog file 3466.documentation.md

• feat: adding env vars needed for multinode

• feat: renaming hpc detection argument

• docs: adding documentation

• chore: adding changelog file 3466.documentation.md

• fix: vale issues

• chore: To fix sphinx build

Squashed commit of the following:

commit c1d1a3e
Author: German [email protected]
Date: Mon Oct 7 15:33:19 2024 +0200

ci: retrigger CICD

commit b7b5c30
Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Mon Oct 7 13:31:55 2024 +0000

ci: auto fixes from pre-commit.com hooks.

for more information, see https://pre-commit.ci

commit 32a1c02
Author: Revathy Venugopal [email protected]
Date: Mon Oct 7 15:31:24 2024 +0200

fix: add suggestions

Co-authored-by: German <[email protected]>

commit 575a219
Merge: f2afe13 be1be2e
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:09:01 2024 +0200

Merge branch 'fix/add-build-cheatsheet-as-env-varaible' of https://github.com/ansys/pymapdl into fix/add-build-cheatsheet-as-env-varaible

commit f2afe13
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:08:58 2024 +0200

fix: precommit

commit be1be2e
Author: pyansys-ci-bot [email protected]
Date: Mon Oct 7 13:07:35 2024 +0000

chore: adding changelog file 3468.fixed.md

commit f052a4d
Author: Revathyvenugopal162 [email protected]
Date: Mon Oct 7 15:05:56 2024 +0200

fix: add build cheatsheet as env variable within doc-build

• docs: expanding a bit troubleshooting advices and small format fix

• docs: fix vale

• fix: nproc tests

• feat: adding env vars needed for multinode

• feat: renaming hpc detection argument

• docs: adding documentation

• chore: adding changelog file 3466.documentation.md

• fix: vale issues

• docs: fix vale

• docs: expanding a bit troubleshooting advices and small format fix

• fix: nproc tests

• revert: "chore: To fix sphinx build"

This reverts commit e45d2e5.

• docs: clarifying where everything is running.

• docs: expanding bash example

• tests: fix

• docs: adding PYMAPDL_NPROC to env var section

• docs: fix vale issue

• docs: fix vale issue

• fix: replacing env var name

• fix: unit tests

• chore: adding changelog file 3466.documentation.md [dependabot-skip]

• Apply suggestions from code review

Co-authored-by: Camille [email protected]

• docs: apply suggestions from code review made by Kathy

Co-authored-by: Kathy Pippert [email protected]

• docs: adding Kathy suggestion.

---

Co-authored-by: pyansys-ci-bot [email protected]
Co-authored-by: Camille [email protected]
Co-authored-by: Kathy Pippert [email protected]

Description

Please provide a brief description of the changes made in this pull request.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[ansys-reviewer-bot]

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

[germa89]

Surprisingly I got so many issues........

[germa89]

Since this is just the doc review from @PipKat made in #3466 . I does not need approval. Hence:

@pyansys-ci-bot LGTM

[pyansys-ci-bot]

✅ Approving this PR because germa89 said so in here 😬

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.31%. Comparing base (e8248a3) to head (baa0069).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3506      +/-   ##
==========================================
- Coverage   82.33%   82.31%   -0.02%     
==========================================
  Files          57       57              
  Lines       10007    10004       -3     
==========================================
- Hits         8239     8235       -4     
- Misses       1768     1769       +1