Skip to content

Conversation

@eblanco-ansys
Copy link
Contributor

Description

Integrate autoapi into the documentation build process, enabling automatic API reference generation. This includes updates to the Sphinx configuration and the addition of a live HTML build option.

Issue linked

#5201
#4775
#4154

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have agreed with the Contributor License Agreement (CLA).

Integrate autoapi into the documentation build process, enabling automatic API reference generation. This includes updates to the Sphinx configuration and the addition of a live HTML build option.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 22, 2025
@codecov
Copy link

codecov bot commented Oct 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 28.38%. Comparing base (28e9942) to head (685b379).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #6800       +/-   ##
===========================================
- Coverage   83.24%   28.38%   -54.87%     
===========================================
  Files         246      246               
  Lines       77489    77436       -53     
===========================================
- Hits        64509    21983    -42526     
- Misses      12980    55453    +42473     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions github-actions bot added the maintenance Package and maintenance related label Oct 22, 2025
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 maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants