diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index f8fc08ee..077885e8 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -208,4 +208,4 @@ pages: TARGET_BRANCH: $CI_COMMIT_TAG - if: '$CI_COMMIT_REF_NAME == "main"' script: - - curl -X POST -d "branches=$CI_COMMIT_REF_NAME" -d "token=$RTD_TOKEN" https://readthedocs.org/api/v2/webhook/bec-widgets/253243/ + - curl -X POST -d "branches=$CI_COMMIT_REF_NAME" -d "token=$RTD_TOKEN" https://readthedocs.org/api/v2/webhook/bec_widgets/253243/ diff --git a/README.md b/README.md index 2c31a169..9ade7136 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,14 @@ BEC Widgets is a GUI framework designed for interaction with [BEC (Beamline Expe Use the package manager [pip](https://pip.pypa.io/en/stable/) to install BEC Widgets: ```bash -pip install bec-widgets +pip install bec_widgets ``` For development purposes, you can clone the repository and install the package locally in editable mode: ```bash git clone https://gitlab.psi.ch/bec/bec-widgets -cd bec-widgets +cd bec_widgets pip install -e .[dev] ``` @@ -22,12 +22,12 @@ BEC Widgets currently supports both PyQt5 and PyQt6. By default, PyQt6 is instal To select a specific Python Qt distribution, install the package with an additional tag: ```bash -pip install bec-widgets[pyqt6] +pip install bec_widgets[pyqt6] ``` or ```bash -pip install bec-widgets[pyqt5] +pip install bec_widgets[pyqt5] ``` ## Documentation diff --git a/docs/developer/developer.md b/docs/developer/developer.md index e73d16b4..37a4f323 100644 --- a/docs/developer/developer.md +++ b/docs/developer/developer.md @@ -13,8 +13,8 @@ To contribute to the development of BEC Widgets, start by setting up the develop 1. **Clone the Repository**: ```bash -git clone https://gitlab.psi.ch/bec/bec-widgets -cd bec-widgets +git clone https://gitlab.psi.ch/bec/bec_widgets +cd bec_widgets ``` 2. **Install in Editable Mode**: diff --git a/docs/user/installation.md b/docs/user/installation.md index 38027db3..b4cb4e7d 100644 --- a/docs/user/installation.md +++ b/docs/user/installation.md @@ -14,7 +14,7 @@ Before installing BEC Widgets, please ensure the following requirements are met: Install BEC Widgets using the pip package manager. Open your terminal and execute: ```bash -pip install bec-widgets +pip install bec_widgets ``` This command installs BEC Widgets along with its dependencies, including the default PyQt6. @@ -26,13 +26,13 @@ BEC Widgets supports both PyQt5 and PyQt6. To install a specific version, use: For PyQt6: ```bash -pip install bec-widgets[pyqt6] +pip install bec_widgets[pyqt6] ``` For PyQt5: ```bash -pip install bec-widgets[pyqt5] +pip install bec_widgets[pyqt5] ``` **Troubleshooting**