Submit RST file edits based on HTML rendering

Author: PipKat

README.rst

@@ -33,7 +33,7 @@ In the upper right corner of the documentation's title bar, there is an option f
 viewing the documentation for the latest stable release to viewing the documentation for the
 development version or previously released versions.
 
-On the `PyEDB-Core <https://github.com/ansys/pyedb-core/issues>`_ page, you can create
+On the `PyEDB-Core Issues <https://github.com/ansys/pyedb-core/issues>`_ page, you can create
 issues to report bugs and request new features. When possible, use these issue templates:
 
 * Bug report template
@@ -53,5 +53,5 @@ License
 PyEDB-Core is licensed under the MIT license.
 
 PyEDB-Core makes no commercial claim over Ansys whatsoever. The use of this Python client requires
-a legally licensed local copy of AEDT. For more information, see the
+a legally licensed copy of AEDT. For more information, see the
 `Ansys Electronics <https://www.ansys.com/products/electronics>`_ page on the Ansys website.

doc/source/contribute.rst

@@ -42,7 +42,7 @@ This package supports Python 3.9 through 3.12 on Windows, Linux, and MacOS.
        # Activate it in a Windows Powershell environment
        .venv\Scripts\Activate.ps1
 
-#. Make sure you have the latest required build system and doc, testing, and CI tools:
+#. Make sure you have the latest required build system and documentation, testing, and CI tools:
 
    .. code:: bash
 
@@ -55,43 +55,43 @@ This package supports Python 3.9 through 3.12 on Windows, Linux, and MacOS.
 
 #. Verify your development installation:
 
-    .. code:: bash
+   .. code:: bash
 
-        tox
+       tox
 
 Testing
 -------
 
-This project takes advantage of `tox`_. This tool allows you to automate common
-development tasks (similar to Makefile), but it is oriented towards Python
-development.
+This project takes advantage of `tox`_. Similar to Makefile, this tool allows you to automate
+common tasks, but it is oriented towards Python development.
 
 Using ``tox``
 ^^^^^^^^^^^^^
 
-As Makefile has rules, `tox`_ has environments. In fact, the tool creates its
+While Makefile has rules, `tox` has environments. In fact, the tool creates its
 own virtual environment so anything being tested is isolated from the project
 to guarantee the project's integrity. The following environments commands are provided:
 
 - **tox -e style**: Checks for coding style quality.
-- **tox -e test**: Checks for unit tests. Replace X with the minor version of your Python environment.
-  Pass `pytest <pytest_>`_ flags after the ``--`` portion of the command. For example, use this
-  ``pytest`` command to show the standard output: ``tox -e py3X -- -s``.
+- **tox -e test**: Checks for unit tests. Pass `pytest <pytest_>`_ flags after the
+  ``--`` portion of the command. For example, use this ``pytest`` command to show the
+  standard output, replacing ``X`` with the minor version of your Python environment:
+  ``tox -e py3X -- -s``.
 - **tox -e coverage**: Checks for code coverage.
-- **tox -e doc**: Checks for the documentation-building process.
+- **tox -e doc**: Checks for documentation building.
 
 Raw testing
 ^^^^^^^^^^^
 
-If required, you can always call style commands, such as `black`_, `isort`_,
-and `flake8`_, or unit testing ones, such as `pytest`_ from the command line.
-However, this does not guarantee that your project is being tested in an isolated
-environment, which is the reason why tools like `tox`_ exist.
+If required, you can always call code style tools, such as `black`_, `isort`_,
+and `flake8`_, or unit testing tools, such as `pytest`_ from the command line.
+However, using these tools do not guarantee that your project is being tested in an isolated
+environment, which is the reason why a tool like `tox`_ exists.
 
 Adhere to code style
 --------------------
 PyEDB-Core follows the PEP8 standard as indicated in `PEP 8 <dev_guide_pyansys_pep8_>`_
-in the *PyAnsys developer's guide* and implements style checking using `pre-commit <pre-commit_>`_.
+in the *PyAnsys developer's guide*. It also implements style checking using `pre-commit <pre-commit_>`_.
 
 To ensure your code meets minimum code styling standards, run these commands:
 
@@ -106,7 +106,7 @@ You can also install this as a pre-commit hook by running this command:
 
   pre-commit install
 
-This way, it's not possible for you to push code that fails the style checks:
+This way, it's not possible for you to push code that fails the code style checks:
 
 .. code:: text
 

doc/source/examples/index.rst

@@ -6,10 +6,10 @@ To run these notebooks, perform these steps:
 
 #. Create and activate a Python `virtual environment <venv_>`_:
 
-    .. code:: bash
+   .. code:: bash
 
-        python -m venv .venv
-        .venv\Scripts\activate.bat
+       python -m venv .venv
+       .venv\Scripts\activate.bat
 
     For more information on creating and installing a virtual environment, see
     :ref:`dev_install`.
@@ -32,17 +32,17 @@ To run these notebooks, perform these steps:
 
        python -m pip install .[notebook]
 
-# Install the IPython kernel:
+#. Install the IPython kernel:
 
    .. code:: bash
 
        ipython kernel install --user --name=.venv
 
 #. Launch Juptyer notebook:
 
-    .. code:: bash
+   .. code:: bash
 
-        jupyter-notebook
+       jupyter-notebook
 
 6. Navigate to desired notebook example, change the kernel to the virtual environment, and execute the notebook
    with the desired settings.

doc/source/getting_started/index.rst

@@ -19,9 +19,9 @@ Installation
 
 #. To install PyEDB-Core, run this command:
 
-.. code:: bash
+   .. code:: bash
 
-    python -m pip install ansys-edb
+       python -m pip install ansys-edb
 
 .. LINKS AND REFERENCES
 .. _pip: https://pypi.org/project/pip/

doc/styles/Vocab/ANSYS/accept.txt

@@ -6,5 +6,7 @@ pyedb
 PyEDB-Core
 EDB
 IPython
+isort
 Juptyer
 Makefile
+pytest