fix: Contributing docs

Author: AlejandroFernandezLuces

CONTRIBUTING.md

@@ -1,76 +1,10 @@
 # Contribute
 
 Overall guidance on contributing to a PyAnsys library appears in the
-[Contributing] topic in the *PyAnsys developer's guide*. Ensure that you
+*Contributing* topic in the *[PyAnsys developer's guide]*. Ensure that you
 are thoroughly familiar with this guide before attempting to contribute to
-allie-flowkit-python.
+allie-flowkit-python. For contributing to this project, please refer to the
+[Contributing] section of this project's documentation.
 
-The following contribution information is specific to *Allie Flowkit Python*.
-
-[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
-
-## Clone the repository
-
-To clone and install the latest *Allie Flowkit Python* release in development mode, run
-these commands:
-
-```bash
-git clone https://github.com/ansys/allie-flowkit-python/
-cd allie-flowkit-python
-python -m pip install --upgrade pip
-pip install -e .
-```
-
-## Adhere to code style
-
-*Allie Flowkit Python* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
-
-To ensure your code meets minimum code styling standards, run these commands:
-
-```bash
-pip install pre-commit
-pre-commit run --all-files
-```
-
-You can also install this as a pre-commit hook by running this command:
-
-```bash
-pre-commit install
-```
-
-## Run the tests
-
-Prior to running the tests, you must run this command to install the test dependencies:
-
-```bash
-pip install -e .[tests]
-```
-
-To run the tests, navigate to the root directory of the repository and run this command:
-
-```bash
-pytest
-```
-
-
-## Build the documentation
-
-Prior to building the documentation, you must run this command to install the documentation dependencies:
-
-```bash
-pip install -e .[doc]
-```
-
-To build the documentation, run the following commands:
-
-```bash
-cd doc
-
-# On linux
-make html
-
-# On windows
-./make.bat html
-```
-
-The documentation is built in the `docs/_build/html` directory.
+[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html
+[Contributing]: expert-adventure-nvnoo1y.pages.github.io/dev/contributing.html

doc/source/contributing.rst

@@ -9,3 +9,73 @@ in the *PyAnsys developer's guide*. Ensure that you are thoroughly familiar
 with this guide before attempting to contribute to the Allie Flowkit Python.
 
 The following contribution information is specific to the Allie Flowkit Python.
+
+
+Clone the repository
+--------------------
+
+To clone and install the latest *Allie Flowkit Python* release in development mode, run
+these commands:
+
+.. code::
+
+    git clone https://github.com/ansys/allie-flowkit-python/
+    cd allie-flowkit-python
+    python -m pip install --upgrade pip
+    pip install -e .
+
+Adhere to code style
+--------------------
+
+*Allie Flowkit Python* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
+
+To ensure your code meets minimum code styling standards, run these commands:
+
+.. code::
+
+    pip install pre-commit
+    pre-commit run --all-files
+
+You can also install this as a pre-commit hook by running this command:
+
+.. code::
+
+    pre-commit install
+
+Run the tests
+-------------
+
+Prior to running the tests, you must run this command to install the test dependencies:
+
+.. code::
+
+    pip install -e .[tests]
+
+To run the tests, navigate to the root directory of the repository and run this command:
+
+.. code::
+
+    pytest
+
+Build the documentation
+-----------------------
+
+Prior to building the documentation, you must run this command to install the documentation dependencies:
+
+.. code::
+
+    pip install -e .[doc]
+
+To build the documentation, run the following commands:
+
+.. code::
+
+    cd doc
+
+    # On linux
+    make html
+
+    # On windows
+    ./make.bat html
+
+The documentation is built in the `docs/_build/html` directory.