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 diff --git a/doc/source/getting_started/installation.rst b/doc/source/getting_started/installation.rst index 124d554d..3ad26300 100644 --- a/doc/source/getting_started/installation.rst +++ b/doc/source/getting_started/installation.rst @@ -107,41 +107,9 @@ Developer installation #. Verify your installation by importing the module: -.. code:: pycon + .. code:: pycon - >>> from ansys.visor.viewer import Visor - - -#. 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. - -Then run these commands: - - -.. code-block:: - - choco install make # install GNU make on Windows - make clean # 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. - -For example: - -.. image:: ../../developer_docs/images/env_vars.png - :alt: Environment variables - :align: center - -.. image:: ../../developer_docs/images/system_env_vars.png - :alt: System environment variables - :align: center + >>> from ansys.visor.viewer import Visor 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