From af0f67a19246f872d60956acd960a6b184d66288 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:02:08 +0200 Subject: [PATCH 1/2] Fixing some format issues in README. --- README.rst | 56 +++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index c1abdd4f..e495e49c 100644 --- a/README.rst +++ b/README.rst @@ -18,8 +18,8 @@ Pyfluent visualization :target: https://codecov.io/gh/pyansys/pyfluent-visualization :alt: Codecov -.. |GH-CI| image:: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci.yml/badge.svg - :target: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci.yml +.. |GH-CI| image:: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci_cd.yml/badge.svg + :target: https://github.com/pyansys/pyfluent-visualization/actions/workflows/ci_cd.yml :alt: GH-CI .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg @@ -66,48 +66,48 @@ need to follow these steps: 1. Start by cloning this repository: - .. code:: bash + .. code:: bash - git clone https://github.com/pyansys/pyfluent-visualization + git clone https://github.com/pyansys/pyfluent-visualization 2. Create a fresh-clean Python environment and activate it: - .. code:: bash + .. code:: bash - # Create a virtual environment - python -m venv .venv + # Create a virtual environment + python -m venv .venv - # Activate it in a POSIX system - source .venv/bin/activate + # Activate it in a POSIX system + source .venv/bin/activate - # Activate it in Windows CMD environment - .venv\Scripts\activate.bat + # Activate it in Windows CMD environment + .venv\Scripts\activate.bat - # Activate it in Windows Powershell - .venv\Scripts\Activate.ps1 + # Activate it in Windows Powershell + .venv\Scripts\Activate.ps1 3. Make sure you have the latest required build system and doc, testing, and CI tools: - .. code:: bash + .. code:: bash - python -m pip install -U pip poetry tox - python -m pip install -r requirements/requirements_build.txt - python -m pip install -r requirements/requirements_doc.txt - python -m pip install -r requirements/requirements_tests.txt + python -m pip install -U pip poetry tox + python -m pip install -r requirements/requirements_build.txt + python -m pip install -r requirements/requirements_doc.txt + python -m pip install -r requirements/requirements_tests.txt 4. Install the project in editable mode: - .. code:: bash + .. code:: bash - cd pyfluent-visualization - poetry run python -m pip install . + cd pyfluent-visualization + poetry run python -m pip install . - 5. Finally, verify your development installation by running: +5. Finally, verify your development installation by running: - .. code:: bash - - tox + .. code:: bash + + tox How to testing @@ -147,7 +147,7 @@ encouraged to install this tool via: .. code:: bash - python -m pip install pre-commit && pre-commit install + python -m pip install pre-commit && pre-commit install Documentation @@ -181,8 +181,8 @@ Then, you can execute: .. code:: bash - poetry build - python -m twine check dist/* + poetry build + python -m twine check dist/* .. LINKS AND REFERENCES .. _black: https://github.com/psf/black From ea7c1dd44adc1d63e7719918a493549ab4cf547a Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Tue, 7 Jun 2022 11:04:27 +0200 Subject: [PATCH 2/2] Second fix --- README.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index e495e49c..fb0f4a68 100644 --- a/README.rst +++ b/README.rst @@ -66,34 +66,34 @@ need to follow these steps: 1. Start by cloning this repository: - .. code:: bash + .. code:: bash - git clone https://github.com/pyansys/pyfluent-visualization + git clone https://github.com/pyansys/pyfluent-visualization 2. Create a fresh-clean Python environment and activate it: - .. code:: bash + .. code:: bash - # Create a virtual environment - python -m venv .venv + # Create a virtual environment + python -m venv .venv - # Activate it in a POSIX system - source .venv/bin/activate + # Activate it in a POSIX system + source .venv/bin/activate - # Activate it in Windows CMD environment - .venv\Scripts\activate.bat + # Activate it in Windows CMD environment + .venv\Scripts\activate.bat - # Activate it in Windows Powershell - .venv\Scripts\Activate.ps1 + # Activate it in Windows Powershell + .venv\Scripts\Activate.ps1 3. Make sure you have the latest required build system and doc, testing, and CI tools: - .. code:: bash + .. code:: bash - python -m pip install -U pip poetry tox - python -m pip install -r requirements/requirements_build.txt - python -m pip install -r requirements/requirements_doc.txt - python -m pip install -r requirements/requirements_tests.txt + python -m pip install -U pip poetry tox + python -m pip install -r requirements/requirements_build.txt + python -m pip install -r requirements/requirements_doc.txt + python -m pip install -r requirements/requirements_tests.txt 4. Install the project in editable mode: