mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 12:54:40 +01:00
63 lines
2.3 KiB
PowerShell
63 lines
2.3 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Helper script to update OpenPype Sphinx sources.
|
|
|
|
.DESCRIPTION
|
|
This script will run apidoc over OpenPype sources and generate new source rst
|
|
files for documentation. Then it will run build_sphinx to create test html
|
|
documentation build.
|
|
|
|
.EXAMPLE
|
|
|
|
PS> .\make_docs.ps1
|
|
|
|
#>
|
|
|
|
$current_dir = Get-Location
|
|
$script_dir = Split-Path -Path $MyInvocation.MyCommand.Definition -Parent
|
|
$openpype_root = (Get-Item $script_dir).parent.FullName
|
|
|
|
# make sure Poetry is in PATH
|
|
if (-not (Test-Path 'env:POETRY_HOME')) {
|
|
$env:POETRY_HOME = "$openpype_root\.poetry"
|
|
}
|
|
$env:PATH = "$($env:PATH);$($env:POETRY_HOME)\bin"
|
|
|
|
Set-Location -Path $openpype_root
|
|
|
|
|
|
$art = @"
|
|
|
|
|
|
▒█▀▀▀█ █▀▀█ █▀▀ █▀▀▄ ▒█▀▀█ █░░█ █▀▀█ █▀▀ ▀█▀ ▀█▀ ▀█▀
|
|
▒█░░▒█ █░░█ █▀▀ █░░█ ▒█▄▄█ █▄▄█ █░░█ █▀▀ ▒█░ ▒█░ ▒█░
|
|
▒█▄▄▄█ █▀▀▀ ▀▀▀ ▀░░▀ ▒█░░░ ▄▄▄█ █▀▀▀ ▀▀▀ ▄█▄ ▄█▄ ▄█▄
|
|
.---= [ by Pype Club ] =---.
|
|
https://openpype.io
|
|
|
|
"@
|
|
|
|
Write-Host $art -ForegroundColor DarkGreen
|
|
|
|
Write-Host ">>> " -NoNewline -ForegroundColor Green
|
|
Write-Host "Reading Poetry ... " -NoNewline
|
|
if (-not (Test-Path -PathType Container -Path "$openpype_root\.poetry\bin")) {
|
|
Write-Host "NOT FOUND" -ForegroundColor Yellow
|
|
Write-Host "*** " -NoNewline -ForegroundColor Yellow
|
|
Write-Host "We need to install Poetry create virtual env first ..."
|
|
& "$openpype_root\tools\create_env.ps1"
|
|
} else {
|
|
Write-Host "OK" -ForegroundColor Green
|
|
}
|
|
|
|
Write-Host "This will not overwrite existing source rst files, only scan and add new."
|
|
Set-Location -Path $openpype_root
|
|
Write-Host ">>> " -NoNewline -ForegroundColor green
|
|
Write-Host "Running apidoc ..."
|
|
& poetry run sphinx-apidoc -M -e -d 10 --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode -o "$($openpype_root)\docs\source" igniter
|
|
& poetry run sphinx-apidoc.exe -M -e -d 10 --ext-intersphinx --ext-todo --ext-coverage --ext-viewcode -o "$($openpype_root)\docs\source" openpype vendor, openpype\vendor
|
|
|
|
Write-Host ">>> " -NoNewline -ForegroundColor green
|
|
Write-Host "Building html ..."
|
|
& poetry run python "$($openpype_root)\setup.py" build_sphinx
|
|
Set-Location -Path $current_dir
|