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

feat: Add cli command to open documentation #941

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

dipinknair
Copy link
Collaborator

@dipinknair dipinknair commented Oct 10, 2024

usage: ansys-mechanical --docs

if this is a good idea, then I can do following in later or this PR.

  • test
  • Should it be different cli like ansys-mechanical-docs ?
  • Docs

@github-actions github-actions bot added the enhancement New features or code improvements label Oct 10, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 10, 2024
Copy link

codecov bot commented Oct 10, 2024

Codecov Report

Attention: Patch coverage is 44.44444% with 5 lines in your changes missing coverage. Please review.

Project coverage is 80.84%. Comparing base (3de0fb5) to head (0939f61).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #941      +/-   ##
==========================================
- Coverage   80.98%   80.84%   -0.15%     
==========================================
  Files          36       36              
  Lines        2272     2281       +9     
==========================================
+ Hits         1840     1844       +4     
- Misses        432      437       +5     

@dipinknair dipinknair marked this pull request as ready for review October 14, 2024 20:17
@dipinknair dipinknair requested a review from a team as a code owner October 14, 2024 20:17
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a bad idea but... is it necessary to provide a CLI option to open the docs? In any case, my preference is ansys-mechanical --docs but I don't really know if this will be useful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants