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: implement autoapi #761

Merged
merged 19 commits into from
Jun 17, 2024
Merged

feat: implement autoapi #761

merged 19 commits into from
Jun 17, 2024

Conversation

klmcadams
Copy link
Collaborator

Implement ansys-sphinx-theme[autoapi] and add docstrings to constants. Please feel free to change the docstrings if there are better descriptions. I deleted the doc/source/api folder to remove the manual API information, but if you think we should keep some of these files lmk

Closes #759

@klmcadams klmcadams requested a review from a team as a code owner June 7, 2024 20:33
@github-actions github-actions bot added documentation Improvements or additions to documentation dependencies Related with project dependencies enhancement New features or code improvements labels Jun 7, 2024
Copy link

codecov bot commented Jun 7, 2024

Codecov Report

Attention: Patch coverage is 97.05882% with 1 line in your changes missing coverage. Please review.

Project coverage is 81.21%. Comparing base (e0006ee) to head (4633c33).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #761      +/-   ##
==========================================
+ Coverage   80.94%   81.21%   +0.26%     
==========================================
  Files          32       32              
  Lines        2015     2049      +34     
==========================================
+ Hits         1631     1664      +33     
- Misses        384      385       +1     

doc/source/index.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@dipinknair dipinknair left a comment

Choose a reason for hiding this comment

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

Awesome !

@klmcadams klmcadams merged commit b139fec into main Jun 17, 2024
57 checks passed
@klmcadams klmcadams deleted the feat/use-autoapi branch June 17, 2024 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies 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.

Set up ansys-sphinx-theme[autoapi] for API reference guide
5 participants