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.

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

Conversation

PipKat
Copy link
Member

@PipKat PipKat commented Aug 9, 2023

Per Landon’s request in the PyAnsys Global AFT on 7/26/23, add a link to the PyMAPDL cheat sheet from this library's documentation.

Note: This library doesn't reuse the README content in the overall index.rst file for documentation. Consequently, I had to add a new "Documentation and issues" section in both the README and the overall index.rst file.

@germa89 The doc build is failing because it isn't finding the external links specified in examples. I have no idea why the "Remote" checks for build and unit testing are failing.

@github-actions github-actions bot added the Documentation Documentation related (improving, adding, etc) label Aug 9, 2023
README.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/source/index.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 9, 2023

Codecov Report

Merging #2235 (d7e5873) into main (e3885fb) will increase coverage by 1.32%.
Report is 79 commits behind head on main.
The diff coverage is 93.67%.

@@            Coverage Diff             @@
##             main    #2235      +/-   ##
==========================================
+ Coverage   86.39%   87.72%   +1.32%     
==========================================
  Files          45       45              
  Lines        7977     8300     +323     
==========================================
+ Hits         6892     7281     +389     
+ Misses       1085     1019      -66     

@RobPasMue RobPasMue requested a review from germa89 August 10, 2023 06:06
@germa89
Copy link
Collaborator

germa89 commented Aug 10, 2023

@germa89 The doc build is failing because it isn't finding the external links specified in examples. I have no idea why the "Remote" checks for build and unit testing are failing.

Don't worry @PipKat, I will take care of it 😄

@germa89
Copy link
Collaborator

germa89 commented Aug 10, 2023

@PipKat feel free to merge whenever you want 😄

@PipKat PipKat merged commit 4f21cc5 into main Aug 10, 2023
23 checks passed
@PipKat PipKat deleted the doc/add_doc_cheat_sheet_links branch August 10, 2023 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation related (improving, adding, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants