-
Notifications
You must be signed in to change notification settings - Fork 7
Add docs infrastructure and uv fixes #12
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
base: develop
Are you sure you want to change the base?
Conversation
|
@antirotor About MK docs, The current setup, relies on:
Same changes here actually: ynput/ayon-houdini#306 |
Where 😅? I didn't find any changes related to powershell or uv. |
| @@ -0,0 +1,27 @@ | |||
| # See https://pre-commit.com for more information | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
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.
|
I was trying to test the mk generation but it gave me Never mind, I'm going to test it via a different way. |
| branches: | ||
| - "enhancement/add-docs-infrastructure" |
There was a problem hiding this comment.
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.
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: