Add docs infrastructure and uv fixes#12
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.
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.
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.
|
I was trying to test the mk generation but it gave me Never mind, I'm going to test it via a different way. |
| Change-Cwd | ||
| function Deploy-UvEnv { | ||
| Set-Cwd | ||
| Write-Color -Text ">>> ", "Test if UV is installed ... " -Color Green, Gray -NoNewline |
There was a problem hiding this comment.
I get this on windows
Line |
160 | Write-Color -Text ">>> ", "Test if UV is installed ... " -Color G …
| ~~~~~~~~~~~
| The term 'Write-Color' is not recognized as a name of a cmdlet, function, script file, or executable program. Check the spelling
| of the name, or if a path was included, verify that the path is correct and try again.
| Write-Host "Commands:" | ||
|
|
||
| Write-Info -Text " create-env ", "Install uv and update venv by lock file" -Color White, Cyan | ||
| Write-Info -Text " ruff-check ", "Run Ruff check for the repository" -Color White, Cyan |
There was a problem hiding this comment.
tools/manage.ps1 ruff-check
raise a lot of things.
Are the Ruff rules a lot than what we used to have?
| Write-Info -Text " ruff-fix ", "Run Ruff fix for the repository" -Color White, Cyan | ||
| Write-Info -Text " codespell ", "Run codespell check for the repository" -Color White, Cyan | ||
| Write-Info -Text " build-docs ", "Build documentation" -Color White, Cyan | ||
| Write-Info -Text " serve-docs ", "Serve documentation locally" -Color White, Cyan |
There was a problem hiding this comment.
I get this from this command.
>>> Cleaning cache files ... OK
error: Failed to spawn: `mkdocs`
Caused by: program not found
| Write-Info -Text " ruff-check ", "Run Ruff check for the repository" -Color White, Cyan | ||
| Write-Info -Text " ruff-fix ", "Run Ruff fix for the repository" -Color White, Cyan | ||
| Write-Info -Text " codespell ", "Run codespell check for the repository" -Color White, Cyan | ||
| Write-Info -Text " build-docs ", "Build documentation" -Color White, Cyan |
There was a problem hiding this comment.
this one has the same result as in https://github.com/ynput/ayon-addon-template/pull/12/changes#r3011399207
btw running uv build docs returns
E:\Ynput\ayon-addon-template>uv build docs
Building source distribution...
× Failed to build `E:\Ynput\ayon-addon-template\docs`
╰─▶ E:\Ynput\ayon-addon-template\docs does not appear to be a Python project, as neither `pyproject.toml` nor `setup.py` are present
in the directory
|
btw, I don't have access to |
|
btw, the way our uv setup works is as follows: |
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: