Reorganize documentation #706
Merged
Conversation
This file contains 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
github-actions
bot
added
the
documentation
github-actions
bot
added
dependencies
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #706 +/- ##
=======================================
Coverage 94.43% 94.43%
=======================================
Files 7 7
Lines 791 791
=======================================
Hits 747 747
Misses 44 44 ☔ View full report in Codecov by Sentry. |
da1910
reviewed
Nov 1, 2024
Co-authored-by: Doug Addy <[email protected]>
da1910
approved these changes
Nov 1, 2024
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.
Closes #705
This PR was originally going to just include the README in the HTML documentation, but I realize the HTML documentation differs significantly from the other PyAnsys documentation styles in terms of structure, so I took this opportunity to re-organize things.
The PyAnsys approach is to include minimal info in the README, limited mainly to installation and getting started. The docs now mirror that approach, and use a sphinx-design gallery to link to other locations. The content from the README has moved to a new User Guide document, which describes how to use openapi-common.