Skip to content

docs: add keywords to autoapi docs#800

Merged
koubaa merged 84 commits intomainfrom
docs/api-keyword
May 15, 2025
Merged

docs: add keywords to autoapi docs#800
koubaa merged 84 commits intomainfrom
docs/api-keyword

Conversation

@Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162 Revathyvenugopal162 commented Apr 29, 2025

Docs CI/CD is split into 3 workflows:

Nightly Docs Build & Deploy

  • Runs every night on an 8-core Ubuntu machine.
  • Builds full docs with autosummary and autoapi.
  • Only the development docs are deployed nightly.

CI/CD on Pull Requests (PRs)

  • Builds documentation without autoapi or autosummary.
  • Does not deploy any docs.
  • Will soon support PR previews using Ansys Actions.

Release CI/CD

  • Triggers on releases.
  • Runs full doc build, full testing, and release actions.
  • Deploys stable documentation.

🧹 Cleanup

  • Removed all actions related to:
  • release branches from the normal workflow.
  • Stable doc deployment from non-release workflows.

@github-actions github-actions bot added maintenance Generic maintenance related ci Pipelines maintenance related labels Apr 29, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 6, 2025
@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review May 14, 2025 07:38
@Revathyvenugopal162 Revathyvenugopal162 requested a review from a team as a code owner May 14, 2025 07:38
@koubaa koubaa merged commit 750d173 into main May 15, 2025
21 checks passed
@koubaa koubaa deleted the docs/api-keyword branch May 15, 2025 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Pipelines maintenance related documentation Improvements or additions to documentation maintenance Generic maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants