Skip to content

Conversation

@antirotor
Copy link
Member

Changelog Description

Add infrastructure to generate API documentation.

Additional review information

This PR is also fixing bugs in powershell tool script about uv logic

Testing notes:

  • all deps should be installed as expected
  • docs should be build

@antirotor antirotor self-assigned this Oct 1, 2025
@antirotor antirotor added the type: enhancement Improvement of existing functionality or minor addition label Oct 1, 2025
@MustafaJafar
Copy link
Member

MustafaJafar commented Dec 15, 2025

@antirotor About MK docs, The current setup, relies on:

  • mkdocs.yml
  • mkdocs_requirments.txt
  • mkdocs_hooks.py
  • docs folder
  • deploy_mkdocs.yml

Same changes here actually: ynput/ayon-houdini#306
and it can be tested from cli as shown in ynput/ayon-core#1441

@MustafaJafar
Copy link
Member

This PR is also fixing bugs in powershell tool script about uv logic

Where 😅? I didn't find any changes related to powershell or uv.

@@ -0,0 +1,27 @@
# See https://pre-commit.com for more information
Copy link
Member

@iLLiCiTiT iLLiCiTiT Dec 16, 2025

Choose a reason for hiding this comment

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

I'm against this pre commit hook. This is just annoying and everybody will ignore the error anyways. The PR should have linting validation instead.

When I just want to commit my current changes to "keep progress" I really don't care about it being ruff valid.

Copy link

Choose a reason for hiding this comment

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

Anything that's invisible and doesn't block me is fine - like end-of-file-fixer or whatever. Those that may block me should just run on the PRs - however, if those are cosmetic things that then take a long time to fix or comment on in average PRs then having them fixed beforehand does make it worth our while.

@@ -0,0 +1,18 @@
name: Deploy MkDocs
Copy link
Member

Choose a reason for hiding this comment

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

Any idea how this will work when someone forks the addon?
I guess it won't work as they won't be able to provide the necessary secrets.

but isn't it the same case with forking any other addon with our github workflows.

@MustafaJafar
Copy link
Member

MustafaJafar commented Dec 22, 2025

I was trying to test the mk generation but it gave me 404 maybe because I was not able to access actions. (can't even see actions tab).

gh workflow run deploy_mkdocs.yml --ref feature/ci-mkdocs-with-enhancements

Never mind, I'm going to test it via a different way.
well, this doesn't work https://docs.ayon.dev/ayon-addon-template/latest yet.

Comment on lines +7 to +8
branches:
- "enhancement/add-docs-infrastructure"
Copy link
Member

Choose a reason for hiding this comment

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

These are for testing. They should be removed before merging the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: enhancement Improvement of existing functionality or minor addition

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants