Improving docs (#380)

Author: RobPasMue

README.rst

@@ -182,6 +182,12 @@ To install PyGeometry in developer mode, perform these steps:
 
       git clone https://github.com/pyansys/pygeometry
 
+#. Access the ``pygeometry`` directory where the repository has been cloned:
+
+   .. code:: bash
+
+      cd pygeometry
+
 #. Create a clean Python virtual environment and activate it:
 
    .. code:: bash
@@ -204,18 +210,21 @@ To install PyGeometry in developer mode, perform these steps:
 
       python -m pip install -U pip tox
 
-
 #. Install the project in editable mode:
 
    .. code:: bash
-    
-      python -m pip install ansys-geometry-core
-        
-#. Verify your development installation by running:
+      
+      # Install the minimum requirements
+      python -m pip install -e .
 
-   .. code:: bash
-        
-      tox
+      # Install the minimum + tests requirements
+      python -m pip install -e .[tests]
+
+      # Install the minimum + doc requirements
+      python -m pip install -e .[doc]
+
+      # Install the all requirements
+      python -m pip install -e .[tests,doc]
 
 Install in offline mode
 ^^^^^^^^^^^^^^^^^^^^^^^

doc/source/getting_started/docker.rst

@@ -1,29 +1,89 @@
+.. _ref_docker:
+
 Geometry service using Docker
 =============================
 
+Docker
+------
+
+Ensure that the machine in which the Geometry service should run has Docker installed. Otherwise,
+please install `Docker Engine <https://docs.docker.com/engine/install/>`_ from the previous link.
+
+.. caution::
+    At the moment, the Geometry service backend is only delivered as a Windows Docker container.
+    As such, this container only runs on a Windows machine. Furthermore, it has also been observed
+    that certain Docker Desktop versions for Windows are not properly configured for running Windows
+    Docker containers. Refer to our section
+    :ref:`Running the Geometry service Windows Docker container <ref_docker_windows>` for further details.
+
+.. _ref_docker_windows:
+
+Running the Geometry service Windows Docker container
+-----------------------------------------------------
+
+For running the Windows Docker container of the Geometry service, please ensure that
+you follow the upcoming steps when installing Docker:
+
+#. Install `Docker Desktop 4.13.1 <https://docs.docker.com/desktop/release-notes/#4131>`_ **or below**.
+   It has been observed that newer versions present problems when running Windows Docker containers.
+
+#. When prompted for ``Use WSL2 instead of Hyper-V (recommended)``, **deselect this option**.
+
+#. Once the installation process finishes, open up Docker Desktop.
+
+#. On ``Settings >> Software updates``, deselect ``Automatically check for updates``. Then, ``Apply & restart``.
+
+#. On the Windows taskbar, go to the ``Show hidden icons`` section, right click on the Docker Desktop app and
+   select ``Switch to Windows containers...``.
+
+At this point, your Docker engine will support running Windows Docker containers. Next step will involve downloading
+the Geometry service Windows Docker image.
+
 Install the PyGeometry image
 ----------------------------
 
+Once you have Docker installed on your machine, the next steps involve pulling down the Geometry service
+Docker container.
+
 #. Using your GitHub credentials, download the Docker image from the `pygeometry <https://github.com/pyansys/pygeometry>`_ repository.
+
 #. If you have Docker installed, use a GitHub personal access token (PAT) with packages read permission to authorize Docker 
    to access this repository. For more information,
    see `creating a personal access token <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_.
 
 #. Save the token to a file:
 
-   .. code:: bash
+    .. code-block:: bash
 
-      echo XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX > GH_TOKEN.txt
+        echo XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX > GH_TOKEN.txt
 
 #. Authorize Docker to access the repository:
 
-   .. code:: bash
+.. tab-set:: 
 
-      GH_USERNAME=<my-github-username>
-      cat GH_TOKEN.txt | docker login docker.pkg.github.com -u $GH_USERNAME --password-stdin
+    .. tab-item:: Linux/Mac
 
-#. Pull the Geometry service locally using Docker with:
+        .. code-block:: bash
+
+            GH_USERNAME=<my-github-username>
+            cat GH_TOKEN.txt | docker login ghcr.io -u $GH_USERNAME --password-stdin
+
+    .. tab-item:: Powershell
+
+        .. code-block:: bash
+
+            $env:GH_USERNAME=<my-github-username>
+            cat GH_TOKEN.txt | docker login ghcr.io -u $env:GH_USERNAME --password-stdin
+
+    .. tab-item:: Windows CMD
 
+        .. code-block:: bash
+
+            SET GH_USERNAME=<my-github-username>
+            type GH_TOKEN.txt | docker login ghcr.io -u %GH_USERNAME% --password-stdin
+
+
+#. Pull the Geometry service locally using Docker with:
 
    .. code:: bash
 
@@ -72,6 +132,14 @@ Depending on the mechanism chosen to launch the Geometry service, you can set th
                     export ANSRV_GEO_ENABLE_TRACE=0
                     export ANSRV_GEO_LOG_LEVEL=2
 
+            .. tab-item:: Powershell
+
+                .. code-block:: bash
+
+                    $env:ANSRV_GEO_LICENSE_SERVER="127.0.0.1"
+                    $env:ANSRV_GEO_ENABLE_TRACE=0
+                    $env:ANSRV_GEO_LOG_LEVEL=2
+
             .. tab-item:: Windows
 
                 .. code-block:: bash

doc/source/getting_started/index.rst

@@ -7,6 +7,11 @@ To use PyGeometry, you must have a local installation of `Docker <https://docs.d
 To start the service locally, you must be `authenticated to ghcr.io
 <https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry>`_.
 
+.. caution::
+   PyGeometry is a client library that works with a Geometry service backend. This service is distributed
+   as a Docker container. At the moment, there is only a Windows Docker container version available for this
+   service. For more information please refer to the :ref:`Geometry service using Docker <ref_docker>` section.
+
 .. toctree::
 
    docker