diff --git a/.ci/build_doc.bat b/.ci/build_doc.bat index 149a9890d0..a8067ca9c0 100644 --- a/.ci/build_doc.bat +++ b/.ci/build_doc.bat @@ -1,5 +1,5 @@ set SPHINX_APIDOC_OPTIONS=inherited-members -call sphinx-apidoc -o ../docs/source/api ../src/ansys ../src/ansys/dpf/core/log.py ^ +call sphinx-apidoc -o ../doc/source/api ../src/ansys ../src/ansys/dpf/core/log.py ^ ../src/ansys/dpf/core/help.py ../src/ansys/dpf/core/mapping_types.py ../src/ansys/dpf/core/ipconfig.py ^ ../src/ansys/dpf/core/field_base.py ../src/ansys/dpf/core/cache.py ../src/ansys/dpf/core/misc.py ^ ../src/ansys/dpf/core/check_version.py ../src/ansys/dpf/core/operators/build.py ../src/ansys/dpf/core/operators/specification.py ^ @@ -8,7 +8,7 @@ call sphinx-apidoc -o ../docs/source/api ../src/ansys ../src/ansys/dpf/core/log. ../src/ansys/dpf/core/property_fields_container.py ^ -f --implicit-namespaces --separate --no-headings pushd . -cd ../docs/ +cd ../doc/ call make clean call make html -v -v -v -P diff --git a/.ci/build_operators_doc.py b/.ci/build_operators_doc.py index a031f071f8..f36feff989 100644 --- a/.ci/build_operators_doc.py +++ b/.ci/build_operators_doc.py @@ -7,5 +7,5 @@ # Generate entry documentation print("Generating operator documentation") print(f"Current context: {SERVER_CONTEXT}") -dpf.operators.utility.html_doc(r"../docs/source/_static/dpf_operators.html").eval() +dpf.operators.utility.html_doc(r"../doc/source/_static/dpf_operators.html").eval() print("Done.\n") diff --git a/.flake8 b/.flake8 index 17e85525f0..c5c5daf0b1 100644 --- a/.flake8 +++ b/.flake8 @@ -1,5 +1,5 @@ [flake8] -exclude = venv, src/ansys/dpf/core/operators, __init__.py, docs/build, .venv, src/ansys/dpf/gate, src/ansys/dpf/gatebin, src/ansys/grpc/dpf +exclude = venv, src/ansys/dpf/core/operators, __init__.py, doc/build, .venv, src/ansys/dpf/gate, src/ansys/dpf/gatebin, src/ansys/grpc/dpf select = W191, W391, E115, E117, E122, E124, E125, E301, W291, W293, E225, E231, E303, E501, F401, F403 per-file-ignores = __init__.py:F401,F403 diff --git a/.github/labeler.yml b/.github/labeler.yml index f1cd367cb2..b59e934d8c 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,5 +1,5 @@ documentation: -- docs/source/**/* +- doc/source/**/* - examples/**/* maintenance: - .flake8 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 704654c2ef..164138f32b 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -52,7 +52,6 @@ jobs: uses: ansys/actions/doc-style@v5.0 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" diff --git a/.github/workflows/update_operators.yml b/.github/workflows/update_operators.yml index b8537d5f2f..859833a298 100644 --- a/.github/workflows/update_operators.yml +++ b/.github/workflows/update_operators.yml @@ -136,7 +136,7 @@ jobs: src/ansys/dpf/gatebin/* src/ansys/grpc/* src/ansys/dpf/core/operators/* - docs/source/_static/dpf_operators.html + doc/source/_static/dpf_operators.html commit-message: update generated code title: Update generated code for DPF ${{ github.event.inputs.ANSYS_VERSION || '242' }}${{ github.event.inputs.standalone_branch_suffix || '' }} on ${{ github.ref_name }} body: An update of generated code has been triggered either manually or by an update in the dpf-standalone repository. diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index cad541b0d1..d00a4c315e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,10 +1,10 @@ exclude: | (?x)^( - docs/source/| + doc/source/| src/ansys/dpf/core/operators/| examples_notebooks/| src/ansys/dpf/core/__init__.py| - docs/styles/| + doc/styles/| src/ansys/dpf/gate/| src/ansys/dpf/gatebin/| src/ansys/grpc/dpf/| diff --git a/Makefile b/Makefile index c7b2d164f4..9b6a574724 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ # Simple makefile to simplify repetitive build env management tasks under posix CODESPELL_DIRS ?= ./ -CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./docs/build/*,./docs/images/*,./dist/*,*~,.hypothesis*,./docs/source/examples/*,*cover,*.dat,*.mac,\#*,build,./ansys/dpf/core/raw_operators.py,./run_client.bat,./docker/v211" +CODESPELL_SKIP ?= "*.pyc,*.txt,*.gif,*.png,*.jpg,*.js,*.html,*.doctree,*.ttf,*.woff,*.woff2,*.eot,*.mp4,*.inv,*.pickle,*.ipynb,flycheck*,./.git/*,./.hypothesis/*,*.yml,./doc/build/*,./doc/images/*,./dist/*,*~,.hypothesis*,./doc/source/examples/*,*cover,*.dat,*.mac,\#*,build,./ansys/dpf/core/raw_operators.py,./run_client.bat,./docker/v211" CODESPELL_IGNORE ?= "ignore_words.txt" all: doctest diff --git a/codecov.yml b/codecov.yml index d8a9d1785e..a76be46360 100644 --- a/codecov.yml +++ b/codecov.yml @@ -15,7 +15,7 @@ coverage: if_no_uploads: error ignore: - "examples" # ignore folder and all its contents - - "docs" # ignore folder and all its contents + - "doc" # ignore folder and all its contents - "docker" # ignore folder and all its contents - "tests" # ignore folder and all its contents - "src/ansys/dpf/core/operators" # ignore folder and all its contents diff --git a/docs/.vale.ini b/doc/.vale.ini similarity index 96% rename from docs/.vale.ini rename to doc/.vale.ini index f2510e048b..79dfe17ca3 100644 --- a/docs/.vale.ini +++ b/doc/.vale.ini @@ -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) \ No newline at end of file diff --git a/docs/make.bat b/doc/make.bat similarity index 96% rename from docs/make.bat rename to doc/make.bat index f925a5d265..6f2dec1e0c 100644 --- a/docs/make.bat +++ b/doc/make.bat @@ -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 diff --git a/docs/source/_static/custom.css b/doc/source/_static/custom.css similarity index 100% rename from docs/source/_static/custom.css rename to doc/source/_static/custom.css diff --git a/docs/source/_static/dpf_operators.html b/doc/source/_static/dpf_operators.html similarity index 100% rename from docs/source/_static/dpf_operators.html rename to doc/source/_static/dpf_operators.html diff --git a/docs/source/_static/simple_example.rst b/doc/source/_static/simple_example.rst similarity index 100% rename from docs/source/_static/simple_example.rst rename to doc/source/_static/simple_example.rst diff --git a/docs/source/api/index.rst b/doc/source/api/index.rst similarity index 100% rename from docs/source/api/index.rst rename to doc/source/api/index.rst diff --git a/docs/source/concepts/concepts.rst b/doc/source/concepts/concepts.rst similarity index 100% rename from docs/source/concepts/concepts.rst rename to doc/source/concepts/concepts.rst diff --git a/docs/source/concepts/index.rst b/doc/source/concepts/index.rst similarity index 100% rename from docs/source/concepts/index.rst rename to doc/source/concepts/index.rst diff --git a/docs/source/concepts/stepbystep.rst b/doc/source/concepts/stepbystep.rst similarity index 100% rename from docs/source/concepts/stepbystep.rst rename to doc/source/concepts/stepbystep.rst diff --git a/docs/source/concepts/waysofusing.rst b/doc/source/concepts/waysofusing.rst similarity index 100% rename from docs/source/concepts/waysofusing.rst rename to doc/source/concepts/waysofusing.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/contributing.rst b/doc/source/contributing.rst similarity index 100% rename from docs/source/contributing.rst rename to doc/source/contributing.rst diff --git a/docs/source/examples/04-advanced/02-volume_averaged_stress/sphx_glr_02-volume_averaged_stress_001.png b/doc/source/examples/04-advanced/02-volume_averaged_stress/sphx_glr_02-volume_averaged_stress_001.png similarity index 100% rename from docs/source/examples/04-advanced/02-volume_averaged_stress/sphx_glr_02-volume_averaged_stress_001.png rename to doc/source/examples/04-advanced/02-volume_averaged_stress/sphx_glr_02-volume_averaged_stress_001.png diff --git a/docs/source/examples/07-python-operators/plugins/README.txt b/doc/source/examples/07-python-operators/plugins/README.txt similarity index 100% rename from docs/source/examples/07-python-operators/plugins/README.txt rename to doc/source/examples/07-python-operators/plugins/README.txt diff --git a/docs/source/examples/07-python-operators/plugins/average_filter_plugin/__init__.py b/doc/source/examples/07-python-operators/plugins/average_filter_plugin/__init__.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/average_filter_plugin/__init__.py rename to doc/source/examples/07-python-operators/plugins/average_filter_plugin/__init__.py diff --git a/docs/source/examples/07-python-operators/plugins/average_filter_plugin/common.py b/doc/source/examples/07-python-operators/plugins/average_filter_plugin/common.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/average_filter_plugin/common.py rename to doc/source/examples/07-python-operators/plugins/average_filter_plugin/common.py diff --git a/docs/source/examples/07-python-operators/plugins/average_filter_plugin/operators.py b/doc/source/examples/07-python-operators/plugins/average_filter_plugin/operators.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/average_filter_plugin/operators.py rename to doc/source/examples/07-python-operators/plugins/average_filter_plugin/operators.py diff --git a/docs/source/examples/07-python-operators/plugins/average_filter_plugin/operators_loader.py b/doc/source/examples/07-python-operators/plugins/average_filter_plugin/operators_loader.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/average_filter_plugin/operators_loader.py rename to doc/source/examples/07-python-operators/plugins/average_filter_plugin/operators_loader.py diff --git a/docs/source/examples/07-python-operators/plugins/easy_statistics.py b/doc/source/examples/07-python-operators/plugins/easy_statistics.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/easy_statistics.py rename to doc/source/examples/07-python-operators/plugins/easy_statistics.py diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin.xml b/doc/source/examples/07-python-operators/plugins/gltf_plugin.xml similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin.xml rename to doc/source/examples/07-python-operators/plugins/gltf_plugin.xml diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/__init__.py b/doc/source/examples/07-python-operators/plugins/gltf_plugin/__init__.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/__init__.py rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/__init__.py diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/gltf_export.py b/doc/source/examples/07-python-operators/plugins/gltf_plugin/gltf_export.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/gltf_export.py rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/gltf_export.py diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/operators.py b/doc/source/examples/07-python-operators/plugins/gltf_plugin/operators.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/operators.py rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/operators.py diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/operators_loader.py b/doc/source/examples/07-python-operators/plugins/gltf_plugin/operators_loader.py similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/operators_loader.py rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/operators_loader.py diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/requirements.txt b/doc/source/examples/07-python-operators/plugins/gltf_plugin/requirements.txt similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/requirements.txt rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/requirements.txt diff --git a/docs/source/examples/07-python-operators/plugins/gltf_plugin/texture.png b/doc/source/examples/07-python-operators/plugins/gltf_plugin/texture.png similarity index 100% rename from docs/source/examples/07-python-operators/plugins/gltf_plugin/texture.png rename to doc/source/examples/07-python-operators/plugins/gltf_plugin/texture.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_001.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_001.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_001.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_001.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_002.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_002.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_002.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_002.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_003.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_003.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_003.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_003.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_004.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_004.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_004.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_004.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_005.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_005.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_005.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_005.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_006.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_006.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_006.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_006.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_007.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_007.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_007.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_007.png diff --git a/docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_thumb.png b/doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_thumb.png similarity index 100% rename from docs/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_thumb.png rename to doc/source/examples/12-fluids/02-fluids_results/sphx_glr_02-fluids_results_thumb.png diff --git a/docs/source/getting_started/compatibility.rst b/doc/source/getting_started/compatibility.rst similarity index 100% rename from docs/source/getting_started/compatibility.rst rename to doc/source/getting_started/compatibility.rst diff --git a/docs/source/getting_started/dependencies.rst b/doc/source/getting_started/dependencies.rst similarity index 100% rename from docs/source/getting_started/dependencies.rst rename to doc/source/getting_started/dependencies.rst diff --git a/docs/source/getting_started/index.rst b/doc/source/getting_started/index.rst old mode 100755 new mode 100644 similarity index 100% rename from docs/source/getting_started/index.rst rename to doc/source/getting_started/index.rst diff --git a/docs/source/getting_started/install.rst b/doc/source/getting_started/install.rst similarity index 100% rename from docs/source/getting_started/install.rst rename to doc/source/getting_started/install.rst diff --git a/docs/source/images/drawings/OperatorPins.png b/doc/source/images/drawings/OperatorPins.png similarity index 100% rename from docs/source/images/drawings/OperatorPins.png rename to doc/source/images/drawings/OperatorPins.png diff --git a/docs/source/images/drawings/Workflow1.png b/doc/source/images/drawings/Workflow1.png similarity index 100% rename from docs/source/images/drawings/Workflow1.png rename to doc/source/images/drawings/Workflow1.png diff --git a/docs/source/images/drawings/Workflow2.png b/doc/source/images/drawings/Workflow2.png similarity index 100% rename from docs/source/images/drawings/Workflow2.png rename to doc/source/images/drawings/Workflow2.png diff --git a/docs/source/images/drawings/apis_2.png b/doc/source/images/drawings/apis_2.png similarity index 100% rename from docs/source/images/drawings/apis_2.png rename to doc/source/images/drawings/apis_2.png diff --git a/docs/source/images/drawings/book-logo.png b/doc/source/images/drawings/book-logo.png similarity index 100% rename from docs/source/images/drawings/book-logo.png rename to doc/source/images/drawings/book-logo.png diff --git a/docs/source/images/drawings/checklist.png b/doc/source/images/drawings/checklist.png similarity index 100% rename from docs/source/images/drawings/checklist.png rename to doc/source/images/drawings/checklist.png diff --git a/docs/source/images/drawings/circuit.png b/doc/source/images/drawings/circuit.png similarity index 100% rename from docs/source/images/drawings/circuit.png rename to doc/source/images/drawings/circuit.png diff --git a/docs/source/images/drawings/connect-operators.png b/doc/source/images/drawings/connect-operators.png similarity index 100% rename from docs/source/images/drawings/connect-operators.png rename to doc/source/images/drawings/connect-operators.png diff --git a/docs/source/images/drawings/dpf-flow.png b/doc/source/images/drawings/dpf-flow.png similarity index 100% rename from docs/source/images/drawings/dpf-flow.png rename to doc/source/images/drawings/dpf-flow.png diff --git a/docs/source/images/drawings/dpf-mech.png b/doc/source/images/drawings/dpf-mech.png similarity index 100% rename from docs/source/images/drawings/dpf-mech.png rename to doc/source/images/drawings/dpf-mech.png diff --git a/docs/source/images/drawings/dpf-reports.png b/doc/source/images/drawings/dpf-reports.png similarity index 100% rename from docs/source/images/drawings/dpf-reports.png rename to doc/source/images/drawings/dpf-reports.png diff --git a/docs/source/images/drawings/dpf_server_client.png b/doc/source/images/drawings/dpf_server_client.png similarity index 100% rename from docs/source/images/drawings/dpf_server_client.png rename to doc/source/images/drawings/dpf_server_client.png diff --git a/docs/source/images/drawings/entry_premium.png b/doc/source/images/drawings/entry_premium.png similarity index 100% rename from docs/source/images/drawings/entry_premium.png rename to doc/source/images/drawings/entry_premium.png diff --git a/docs/source/images/drawings/field-breakdown.png b/doc/source/images/drawings/field-breakdown.png similarity index 100% rename from docs/source/images/drawings/field-breakdown.png rename to doc/source/images/drawings/field-breakdown.png diff --git a/docs/source/images/drawings/field-con-overview.png b/doc/source/images/drawings/field-con-overview.png similarity index 100% rename from docs/source/images/drawings/field-con-overview.png rename to doc/source/images/drawings/field-con-overview.png diff --git a/docs/source/images/drawings/field-con.png b/doc/source/images/drawings/field-con.png similarity index 100% rename from docs/source/images/drawings/field-con.png rename to doc/source/images/drawings/field-con.png diff --git a/docs/source/images/drawings/field.png b/doc/source/images/drawings/field.png similarity index 100% rename from docs/source/images/drawings/field.png rename to doc/source/images/drawings/field.png diff --git a/docs/source/images/drawings/help-operators.png b/doc/source/images/drawings/help-operators.png similarity index 100% rename from docs/source/images/drawings/help-operators.png rename to doc/source/images/drawings/help-operators.png diff --git a/docs/source/images/drawings/max_u_norm.png b/doc/source/images/drawings/max_u_norm.png similarity index 100% rename from docs/source/images/drawings/max_u_norm.png rename to doc/source/images/drawings/max_u_norm.png diff --git a/docs/source/images/drawings/model.png b/doc/source/images/drawings/model.png similarity index 100% rename from docs/source/images/drawings/model.png rename to doc/source/images/drawings/model.png diff --git a/docs/source/images/drawings/operator-def.png b/doc/source/images/drawings/operator-def.png similarity index 100% rename from docs/source/images/drawings/operator-def.png rename to doc/source/images/drawings/operator-def.png diff --git a/docs/source/images/drawings/operator_drawing.svg b/doc/source/images/drawings/operator_drawing.svg similarity index 100% rename from docs/source/images/drawings/operator_drawing.svg rename to doc/source/images/drawings/operator_drawing.svg diff --git a/docs/source/images/drawings/plugin-logo.png b/doc/source/images/drawings/plugin-logo.png similarity index 100% rename from docs/source/images/drawings/plugin-logo.png rename to doc/source/images/drawings/plugin-logo.png diff --git a/docs/source/images/drawings/remote_machines.png b/doc/source/images/drawings/remote_machines.png similarity index 100% rename from docs/source/images/drawings/remote_machines.png rename to doc/source/images/drawings/remote_machines.png diff --git a/docs/source/images/drawings/scoping-eg.png b/doc/source/images/drawings/scoping-eg.png similarity index 100% rename from docs/source/images/drawings/scoping-eg.png rename to doc/source/images/drawings/scoping-eg.png diff --git a/docs/source/images/drawings/small_operator.svg b/doc/source/images/drawings/small_operator.svg similarity index 100% rename from docs/source/images/drawings/small_operator.svg rename to doc/source/images/drawings/small_operator.svg diff --git a/docs/source/images/drawings/using-dpf.png b/doc/source/images/drawings/using-dpf.png similarity index 100% rename from docs/source/images/drawings/using-dpf.png rename to doc/source/images/drawings/using-dpf.png diff --git a/docs/source/images/drawings/values-entities.png b/doc/source/images/drawings/values-entities.png similarity index 100% rename from docs/source/images/drawings/values-entities.png rename to doc/source/images/drawings/values-entities.png diff --git a/docs/source/images/drawings/xml.png b/doc/source/images/drawings/xml.png similarity index 100% rename from docs/source/images/drawings/xml.png rename to doc/source/images/drawings/xml.png diff --git a/docs/source/images/plotting/crankshaft_disp.png b/doc/source/images/plotting/crankshaft_disp.png similarity index 100% rename from docs/source/images/plotting/crankshaft_disp.png rename to doc/source/images/plotting/crankshaft_disp.png diff --git a/docs/source/images/plotting/pontoon.png b/doc/source/images/plotting/pontoon.png similarity index 100% rename from docs/source/images/plotting/pontoon.png rename to doc/source/images/plotting/pontoon.png diff --git a/docs/source/images/plotting/pontoon_strain.png b/doc/source/images/plotting/pontoon_strain.png similarity index 100% rename from docs/source/images/plotting/pontoon_strain.png rename to doc/source/images/plotting/pontoon_strain.png diff --git a/docs/source/images/plotting/simple_example.png b/doc/source/images/plotting/simple_example.png similarity index 100% rename from docs/source/images/plotting/simple_example.png rename to doc/source/images/plotting/simple_example.png diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/operator_reference.rst b/doc/source/operator_reference.rst similarity index 100% rename from docs/source/operator_reference.rst rename to doc/source/operator_reference.rst diff --git a/docs/source/operator_reference_load.rst b/doc/source/operator_reference_load.rst similarity index 100% rename from docs/source/operator_reference_load.rst rename to doc/source/operator_reference_load.rst diff --git a/docs/source/operator_reference_load_apis.rst b/doc/source/operator_reference_load_apis.rst similarity index 100% rename from docs/source/operator_reference_load_apis.rst rename to doc/source/operator_reference_load_apis.rst diff --git a/docs/source/pydpf-core_clone_install.rst b/doc/source/pydpf-core_clone_install.rst similarity index 100% rename from docs/source/pydpf-core_clone_install.rst rename to doc/source/pydpf-core_clone_install.rst diff --git a/docs/source/user_guide/create_sites_for_python_operators.ps1 b/doc/source/user_guide/create_sites_for_python_operators.ps1 similarity index 100% rename from docs/source/user_guide/create_sites_for_python_operators.ps1 rename to doc/source/user_guide/create_sites_for_python_operators.ps1 diff --git a/docs/source/user_guide/create_sites_for_python_operators.sh b/doc/source/user_guide/create_sites_for_python_operators.sh similarity index 100% rename from docs/source/user_guide/create_sites_for_python_operators.sh rename to doc/source/user_guide/create_sites_for_python_operators.sh diff --git a/docs/source/user_guide/custom_operator_example.py b/doc/source/user_guide/custom_operator_example.py similarity index 100% rename from docs/source/user_guide/custom_operator_example.py rename to doc/source/user_guide/custom_operator_example.py diff --git a/docs/source/user_guide/custom_operators.rst b/doc/source/user_guide/custom_operators.rst similarity index 100% rename from docs/source/user_guide/custom_operators.rst rename to doc/source/user_guide/custom_operators.rst diff --git a/docs/source/user_guide/custom_operators_deps.rst b/doc/source/user_guide/custom_operators_deps.rst similarity index 100% rename from docs/source/user_guide/custom_operators_deps.rst rename to doc/source/user_guide/custom_operators_deps.rst diff --git a/docs/source/user_guide/custom_plugin.xml b/doc/source/user_guide/custom_plugin.xml similarity index 100% rename from docs/source/user_guide/custom_plugin.xml rename to doc/source/user_guide/custom_plugin.xml diff --git a/docs/source/user_guide/fields_container.rst b/doc/source/user_guide/fields_container.rst similarity index 100% rename from docs/source/user_guide/fields_container.rst rename to doc/source/user_guide/fields_container.rst diff --git a/docs/source/user_guide/getting_started_with_dpf_server.rst b/doc/source/user_guide/getting_started_with_dpf_server.rst similarity index 100% rename from docs/source/user_guide/getting_started_with_dpf_server.rst rename to doc/source/user_guide/getting_started_with_dpf_server.rst diff --git a/docs/source/user_guide/how_to.rst b/doc/source/user_guide/how_to.rst similarity index 100% rename from docs/source/user_guide/how_to.rst rename to doc/source/user_guide/how_to.rst diff --git a/docs/source/user_guide/index.rst b/doc/source/user_guide/index.rst similarity index 100% rename from docs/source/user_guide/index.rst rename to doc/source/user_guide/index.rst diff --git a/docs/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 b/doc/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 similarity index 100% rename from docs/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 rename to doc/source/user_guide/install_ansys_dpf_core_in_ansys.ps1 diff --git a/docs/source/user_guide/install_ansys_dpf_core_in_ansys.sh b/doc/source/user_guide/install_ansys_dpf_core_in_ansys.sh old mode 100755 new mode 100644 similarity index 100% rename from docs/source/user_guide/install_ansys_dpf_core_in_ansys.sh rename to doc/source/user_guide/install_ansys_dpf_core_in_ansys.sh diff --git a/docs/source/user_guide/main_entities.rst b/doc/source/user_guide/main_entities.rst similarity index 100% rename from docs/source/user_guide/main_entities.rst rename to doc/source/user_guide/main_entities.rst diff --git a/docs/source/user_guide/model.rst b/doc/source/user_guide/model.rst similarity index 100% rename from docs/source/user_guide/model.rst rename to doc/source/user_guide/model.rst diff --git a/docs/source/user_guide/operators.rst b/doc/source/user_guide/operators.rst similarity index 100% rename from docs/source/user_guide/operators.rst rename to doc/source/user_guide/operators.rst diff --git a/docs/source/user_guide/plotting.rst b/doc/source/user_guide/plotting.rst similarity index 100% rename from docs/source/user_guide/plotting.rst rename to doc/source/user_guide/plotting.rst diff --git a/docs/source/user_guide/server_context.rst b/doc/source/user_guide/server_context.rst similarity index 100% rename from docs/source/user_guide/server_context.rst rename to doc/source/user_guide/server_context.rst diff --git a/docs/source/user_guide/server_types.rst b/doc/source/user_guide/server_types.rst similarity index 100% rename from docs/source/user_guide/server_types.rst rename to doc/source/user_guide/server_types.rst diff --git a/docs/source/user_guide/troubleshooting.rst b/doc/source/user_guide/troubleshooting.rst similarity index 100% rename from docs/source/user_guide/troubleshooting.rst rename to doc/source/user_guide/troubleshooting.rst diff --git a/docs/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 b/doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 similarity index 100% rename from docs/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 rename to doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.ps1 diff --git a/docs/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh b/doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh old mode 100755 new mode 100644 similarity index 100% rename from docs/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh rename to doc/source/user_guide/uninstall_ansys_dpf_core_in_ansys.sh diff --git a/docs/source/user_guide/xmlfiles.rst b/doc/source/user_guide/xmlfiles.rst similarity index 100% rename from docs/source/user_guide/xmlfiles.rst rename to doc/source/user_guide/xmlfiles.rst diff --git a/docs/styles/.gitignore b/doc/styles/.gitignore similarity index 90% rename from docs/styles/.gitignore rename to doc/styles/.gitignore index 943db7cb51..080f12aa43 100644 --- a/docs/styles/.gitignore +++ b/doc/styles/.gitignore @@ -1,4 +1,4 @@ -* -!Vocab -!Vocab/** +* +!Vocab +!Vocab/** !.gitignore \ No newline at end of file diff --git a/docs/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt similarity index 90% rename from docs/styles/Vocab/ANSYS/accept.txt rename to doc/styles/Vocab/ANSYS/accept.txt index 0ea0deb25c..16005462df 100644 --- a/docs/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -1,41 +1,41 @@ -ANSYS -[Aa]nsys -Abaqus -APIs -[Cc]omponentization -[Cc]ore -CPython -DPF [Ss]erver -DPFArray -Entry -Gaussian -getters -gltf -GLTF -grpcio -hexa -IronPython -matplotlib -Mises -MSUP -numpy -postprocess -[Pp]ostprocessing -Premium -Preview License Agreement -protobuf -psutil -PyDPF -[Pp]ython -Pythonic -[Pp]yvista -recursivity -Remotable -Reusability -Rz -scopings -serializer -setuptools -substep -tqdm +ANSYS +[Aa]nsys +Abaqus +APIs +[Cc]omponentization +[Cc]ore +CPython +DPF [Ss]erver +DPFArray +Entry +Gaussian +getters +gltf +GLTF +grpcio +hexa +IronPython +matplotlib +Mises +MSUP +numpy +postprocess +[Pp]ostprocessing +Premium +Preview License Agreement +protobuf +psutil +PyDPF +[Pp]ython +Pythonic +[Pp]yvista +recursivity +Remotable +Reusability +Rz +scopings +serializer +setuptools +substep +tqdm von \ No newline at end of file diff --git a/docs/styles/Vocab/ANSYS/reject.txt b/doc/styles/Vocab/ANSYS/reject.txt similarity index 100% rename from docs/styles/Vocab/ANSYS/reject.txt rename to doc/styles/Vocab/ANSYS/reject.txt diff --git a/examples/08-python-operators/02-python_operators_with_dependencies.py b/examples/08-python-operators/02-python_operators_with_dependencies.py index 720de18daf..1c72c0a098 100644 --- a/examples/08-python-operators/02-python_operators_with_dependencies.py +++ b/examples/08-python-operators/02-python_operators_with_dependencies.py @@ -54,7 +54,7 @@ import os folder_root = os.path.join(os.getcwd().rsplit("pydpf-core", 1)[0], "pydpf-core") -source_path_in_repo = r"docs\source\examples\07-python-operators\plugins" +source_path_in_repo = r"doc\source\examples\07-python-operators\plugins" operator_folder = os.path.join(folder_root, source_path_in_repo) print(operator_folder) plugin_path = None @@ -132,7 +132,7 @@ ): cmd_file = os.path.join( folder_root, - "docs", + "doc", "source", "user_guide", "create_sites_for_python_operators.ps1", @@ -164,7 +164,7 @@ ): cmd_file = os.path.join( folder_root, - "docs", + "doc", "source", "user_guide", "create_sites_for_python_operators.sh",