From 94afcc01da555ac6f82b07511c0a65d71e15b0cb Mon Sep 17 00:00:00 2001 From: Laura Kasian Date: Tue, 1 Sep 2026 06:27:07 -0700 Subject: [PATCH 1/3] docs: clean up installation page --- doc/source/getting_started/installation.rst | 38 +++++++++------------ 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 124d554d..235168ae 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -107,41 +107,35 @@ Developer installation #. Verify your installation by importing the module: -.. code:: pycon + .. code:: pycon - >>> from ansys.visor.viewer import Visor + >>> from ansys.visor.viewer import Visor -#. Clean the build environment (optional) +#. Clean the build environment (optional): -If you want to create a production-like installation on Windows, first install Chocolatey as described in -[Installing Chocolatey](https://chocolatey.org/install). You do not need this step on other operating systems. + To clean the build environment, run the following command in the root of the VISOR repository: -Then run these commands: - - -.. code-block:: + .. code:: console - choco install make # install GNU make on Windows - make clean # clean + make clean + To run this on Windows, you need to install GNU make. First install Chocolatey as described in + `Installing Chocolatey `_. You do not need this step on other operating systems. -If you get a `find` command error on Windows, your shell might be calling the Windows version of `find` instead -of the expected Unix command. + Then run these commands: -1. Verify that Git Bash is installed, for example in `C:\Program Files\Git\usr\bin`. + .. code:: console -2. Add `C:\Program Files\Git\usr\bin` to your system `PATH` before the `System32` path. + choco install make # install GNU make on Windows + make clean -For example: + If you get a ``find`` command error on Windows, your shell might be calling the Windows version of ``find`` instead + of the expected Unix command. -.. image:: ../../developer_docs/images/env_vars.png - :alt: Environment variables - :align: center + 1. Verify that Git Bash is installed, for example in ``C:\Program Files\Git\usr\bin``. -.. image:: ../../developer_docs/images/system_env_vars.png - :alt: System environment variables - :align: center + 2. Add ``C:\Program Files\Git\usr\bin`` to your system ``PATH`` before the ``System32`` path. From 5b13f6c93727ab2dd1407352f45d8d6b0d6868d2 Mon Sep 17 00:00:00 2001 From: Laura Kasian Date: Tue, 1 Sep 2026 06:50:49 -0700 Subject: [PATCH 2/3] remove unused Makefile and reference to it in docs --- doc/source/getting_started/installation.rst | 26 --------------------- tools/Makefile | 23 ------------------ 2 files changed, 49 deletions(-) delete mode 100644 tools/Makefile diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 235168ae..3ad26300 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -112,30 +112,4 @@ Developer installation >>> from ansys.visor.viewer import Visor -#. Clean the build environment (optional): - - To clean the build environment, run the following command in the root of the VISOR repository: - - .. code:: console - - make clean - - To run this on Windows, you need to install GNU make. First install Chocolatey as described in - `Installing Chocolatey `_. You do not need this step on other operating systems. - - Then run these commands: - - .. code:: console - - choco install make # install GNU make on Windows - make clean - - If you get a ``find`` command error on Windows, your shell might be calling the Windows version of ``find`` instead - of the expected Unix command. - - 1. Verify that Git Bash is installed, for example in ``C:\Program Files\Git\usr\bin``. - - 2. Add ``C:\Program Files\Git\usr\bin`` to your system ``PATH`` before the ``System32`` path. - - diff --git a/tools/Makefile b/tools/Makefile deleted file mode 100644 index a8956c2b..00000000 --- a/tools/Makefile +++ /dev/null @@ -1,23 +0,0 @@ -FRONTEND_DIR ?= src/ansys/visor/visor-client -FRONTEND_BUILD_DIR ?= $(FRONTEND_DIR)/dist -BACKEND_STATIC_DIR ?= src/ansys/visor/viewer/client_bundle -WASM_OUT_DIR ?= $(BACKEND_STATIC_DIR)/wasm - -.PHONY: clean clean-all _clean_python _clean_frontend _clean_static - -_clean_python: - find . -type d -name "__pycache__" -prune -exec rm -rf {} + - find . -type f -name "*.py[co]" -delete - rm -rf build/ dist/ *.egg-info .pytest_cache coverage-html - -_clean_frontend: - rm -rf $(FRONTEND_BUILD_DIR) $(FRONTEND_DIR)/build $(FRONTEND_DIR)/.vite $(FRONTEND_DIR)/.cache $(FRONTEND_DIR)/.parcel-cache - -_clean_static: - rm -rf $(WASM_OUT_DIR) $(BACKEND_STATIC_DIR)/assets $(BACKEND_STATIC_DIR)/manifest.* $(BACKEND_STATIC_DIR)/_temp tmp temp - -clean: - @$(MAKE) -s _clean_python _clean_frontend _clean_static - -clean-all: clean - @rm -rf $(FRONTEND_DIR)/node_modules From 30836c74c4c8a63bc139682329b2332c6f76ab7d Mon Sep 17 00:00:00 2001 From: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Tue, 1 Sep 2026 13:56:45 +0000 Subject: [PATCH 3/3] chore: adding changelog file 56.documentation.md [dependabot-skip] --- doc/changelog.d/56.documentation.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/changelog.d/56.documentation.md diff --git a/doc/changelog.d/56.documentation.md b/doc/changelog.d/56.documentation.md new file mode 100644 index 00000000..d443ee17 --- /dev/null +++ b/doc/changelog.d/56.documentation.md @@ -0,0 +1 @@ +Clean up doc installation section and remove unused Makefile