-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: paul.profizi <[email protected]>
- Loading branch information
Showing
576 changed files
with
35,050 additions
and
175 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
documentation: | ||
- docs/source/**/* | ||
- doc/source/**/* | ||
- examples/**/* | ||
maintenance: | ||
- .flake8 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -52,7 +52,6 @@ jobs: | |
uses: ansys/actions/[email protected] | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
vale-config: "docs/.vale.ini" | ||
|
||
docs: | ||
name: "Documentation" | ||
|
@@ -140,12 +139,12 @@ jobs: | |
shell: cmd | ||
working-directory: .ci | ||
run: | | ||
build_doc.bat > ..\docs\log.txt && type ..\docs\log.txt 2>&1 | ||
build_doc.bat > ..\doc\log.txt && type ..\doc\log.txt 2>&1 | ||
timeout-minutes: 60 | ||
|
||
- name: "Check for success" | ||
shell: bash | ||
working-directory: docs | ||
working-directory: doc | ||
run: | | ||
case `grep -F "build succeeded" log.txt >/dev/null; echo $?` in | ||
0) | ||
|
@@ -175,13 +174,13 @@ jobs: | |
uses: actions/upload-artifact@v3 | ||
with: | ||
name: doc-${{env.PACKAGE_NAME}}-log | ||
path: docs/*.txt | ||
path: doc/*.txt | ||
if: always() | ||
|
||
- name: "Zip HTML Documentation" | ||
shell: pwsh | ||
run: | | ||
Compress-Archive -Path docs/build/html/* -Destination HTML-doc-${{env.PACKAGE_NAME}}.zip | ||
Compress-Archive -Path doc/build/html/* -Destination HTML-doc-${{env.PACKAGE_NAME}}.zip | ||
if: always() | ||
|
||
- name: "Upload HTML Documentation" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,43 @@ | ||
# Core settings | ||
# ============= | ||
|
||
# Location of our `styles` | ||
StylesPath = "styles" | ||
|
||
# The options are `suggestion`, `warning`, or `error` (defaults to “warning”). | ||
MinAlertLevel = warning | ||
|
||
# By default, `code` and `tt` are ignored. | ||
IgnoredScopes = code, tt | ||
|
||
# By default, `script`, `style`, `pre`, and `figure` are ignored. | ||
SkippedScopes = script, style, pre, figure | ||
|
||
# WordTemplate specifies what Vale will consider to be an individual word. | ||
WordTemplate = \b(?:%s)\b | ||
|
||
# List of Packages to be used for our guidelines | ||
Packages = Google | ||
|
||
# Define the Ansys vocabulary | ||
Vocab = ANSYS | ||
|
||
[*.{md,rst}] | ||
|
||
# Apply the following styles | ||
BasedOnStyles = Vale, Google | ||
|
||
# Removing Google-specific rule - Not applicable under some circumstances | ||
Google.WordList = NO | ||
Google.Colons = NO | ||
Google.Headings = NO | ||
|
||
[formats] | ||
# Format associations appear under | ||
# the optional "formats" section. | ||
|
||
[*] | ||
# Format-specific settings appear | ||
# under a user-provided "glob" | ||
# pattern. | ||
# Core settings | ||
# ============= | ||
|
||
# Location of our `styles` | ||
StylesPath = "styles" | ||
|
||
# The options are `suggestion`, `warning`, or `error` (defaults to “warning”). | ||
MinAlertLevel = warning | ||
|
||
# By default, `code` and `tt` are ignored. | ||
IgnoredScopes = code, tt | ||
|
||
# By default, `script`, `style`, `pre`, and `figure` are ignored. | ||
SkippedScopes = script, style, pre, figure | ||
|
||
# WordTemplate specifies what Vale will consider to be an individual word. | ||
WordTemplate = \b(?:%s)\b | ||
|
||
# List of Packages to be used for our guidelines | ||
Packages = Google | ||
|
||
# Define the Ansys vocabulary | ||
Vocab = ANSYS | ||
|
||
[*.{md,rst}] | ||
|
||
# Apply the following styles | ||
BasedOnStyles = Vale, Google | ||
|
||
# Removing Google-specific rule - Not applicable under some circumstances | ||
Google.WordList = NO | ||
Google.Colons = NO | ||
Google.Headings = NO | ||
|
||
[formats] | ||
# Format associations appear under | ||
# the optional "formats" section. | ||
|
||
[*] | ||
# Format-specific settings appear | ||
# under a user-provided "glob" | ||
# pattern. | ||
TokenIgnores = (:class:\x60.*\x60|:meth:\x60.*\x60|:py:class:\x60.*\x60|:py:meth:\x60.*\x60) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,72 @@ | ||
@ECHO OFF | ||
|
||
pushd %~dp0 | ||
|
||
REM Command file for Sphinx documentation | ||
|
||
if "%SPHINXBUILD%" == "" ( | ||
set SPHINXBUILD=sphinx-build | ||
) | ||
set SOURCEDIR=source | ||
set BUILDDIR=build | ||
|
||
if "%1" == "" goto help | ||
if "%1" == "clean" goto clean | ||
|
||
%SPHINXBUILD% >NUL 2>NUL | ||
if errorlevel 9009 ( | ||
echo. | ||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
echo.installed, then set the SPHINXBUILD environment variable to point | ||
echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
echo.may add the Sphinx directory to PATH. | ||
echo. | ||
echo.If you don't have Sphinx installed, grab it from | ||
echo.http://sphinx-doc.org/ | ||
exit /b 1 | ||
) | ||
|
||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
goto end | ||
|
||
:clean | ||
echo.Cleaning files form previous build... | ||
IF EXIST "build" ( | ||
rmdir "build" /s /q | ||
) | ||
IF EXIST "source\images\auto-generated" ( | ||
rmdir "source\images\auto-generated" /s /q | ||
) | ||
IF EXIST "source\examples\07-python-operators\plugins" ( | ||
robocopy "source\examples\07-python-operators\plugins" "source\_temp\plugins" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples\04-advanced\02-volume_averaged_stress" ( | ||
robocopy "source\examples\04-advanced\02-volume_averaged_stress" "source\_temp\04_advanced" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples\12-fluids\02-fluids_results" ( | ||
robocopy "source\examples\12-fluids\02-fluids_results" "source\_temp\12_fluids" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples" ( | ||
rmdir "source\examples" /s /q | ||
) | ||
IF EXIST "source\_temp\plugins" ( | ||
robocopy "source\_temp\plugins" "source\examples\07-python-operators\plugins" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp\04_advanced" ( | ||
robocopy "source\_temp\04_advanced" "source\examples\04-advanced\02-volume_averaged_stress" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp\12_fluids" ( | ||
robocopy "source\_temp\12_fluids" "source\examples\12-fluids\02-fluids_results" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp" ( | ||
rmdir "source\_temp" /s /q | ||
) | ||
|
||
echo.Done. | ||
goto end | ||
|
||
:help | ||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
|
||
:end | ||
popd | ||
@ECHO OFF | ||
|
||
pushd %~dp0 | ||
|
||
REM Command file for Sphinx documentation | ||
|
||
if "%SPHINXBUILD%" == "" ( | ||
set SPHINXBUILD=sphinx-build | ||
) | ||
set SOURCEDIR=source | ||
set BUILDDIR=build | ||
|
||
if "%1" == "" goto help | ||
if "%1" == "clean" goto clean | ||
|
||
%SPHINXBUILD% >NUL 2>NUL | ||
if errorlevel 9009 ( | ||
echo. | ||
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx | ||
echo.installed, then set the SPHINXBUILD environment variable to point | ||
echo.to the full path of the 'sphinx-build' executable. Alternatively you | ||
echo.may add the Sphinx directory to PATH. | ||
echo. | ||
echo.If you don't have Sphinx installed, grab it from | ||
echo.http://sphinx-doc.org/ | ||
exit /b 1 | ||
) | ||
|
||
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
goto end | ||
|
||
:clean | ||
echo.Cleaning files form previous build... | ||
IF EXIST "build" ( | ||
rmdir "build" /s /q | ||
) | ||
IF EXIST "source\images\auto-generated" ( | ||
rmdir "source\images\auto-generated" /s /q | ||
) | ||
IF EXIST "source\examples\07-python-operators\plugins" ( | ||
robocopy "source\examples\07-python-operators\plugins" "source\_temp\plugins" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples\04-advanced\02-volume_averaged_stress" ( | ||
robocopy "source\examples\04-advanced\02-volume_averaged_stress" "source\_temp\04_advanced" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples\12-fluids\02-fluids_results" ( | ||
robocopy "source\examples\12-fluids\02-fluids_results" "source\_temp\12_fluids" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\examples" ( | ||
rmdir "source\examples" /s /q | ||
) | ||
IF EXIST "source\_temp\plugins" ( | ||
robocopy "source\_temp\plugins" "source\examples\07-python-operators\plugins" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp\04_advanced" ( | ||
robocopy "source\_temp\04_advanced" "source\examples\04-advanced\02-volume_averaged_stress" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp\12_fluids" ( | ||
robocopy "source\_temp\12_fluids" "source\examples\12-fluids\02-fluids_results" /E >nul 2>&1 | ||
) | ||
IF EXIST "source\_temp" ( | ||
rmdir "source\_temp" /s /q | ||
) | ||
|
||
echo.Done. | ||
goto end | ||
|
||
:help | ||
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% | ||
|
||
:end | ||
popd |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.