Open
Conversation
- Moved troubleshoot.rst from user_guide to getting_started - Updated getting_started/index.rst to include troubleshoot in Resources section - Updated user_guide/index.rst to remove troubleshoot reference - Updated links.rst to reflect new path Fixes #4438 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
bot
added
the
documentation
germa89
commented
Mar 2, 2026
10 tasks
Contributor
Contributor
There was a problem hiding this comment.
Pull request overview
Reorganizes the Sphinx documentation so the general PyMAPDL troubleshooting page lives under Getting started alongside the FAQ, improving discoverability as requested in #4438.
Changes:
- Removed the troubleshooting page entry from
user_guide/index.rst. - Added the troubleshooting page to the
getting_started/index.rstResources toctree (immediately after FAQ). - Updated
links.rstto point the Ubuntu troubleshooting link to the new documentation path.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| doc/source/user_guide/index.rst | Removes the troubleshoot page from the User guide toctree. |
| doc/source/getting_started/index.rst | Adds troubleshoot into the Getting started “Resources” section next to faq. |
| doc/source/getting_started/troubleshoot.rst | Adds the troubleshooting content at the new location while preserving the ref_troubleshooting anchor. |
| doc/source/links.rst | Updates the pymapdl_run_ubuntu URL to the new getting_started/troubleshoot.html path. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4448 +/- ##
==========================================
- Coverage 91.23% 89.89% -1.35%
==========================================
Files 196 196
Lines 16209 16209
==========================================
- Hits 14789 14571 -218
- Misses 1420 1638 +218 🚀 New features to boost your workflow:
|
Collaborator
Author
|
Please @PipKat a quick review? |
germa89
changed the title
Collaborator
Author
|
Close #4397 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR reorganizes the documentation structure to place the troubleshooting section closer to the FAQ, as requested in #4438.
Changes
Benefits
ef_troubleshooting) continue to work correctly
Fixes #4438