update links to the documentation

CONTRIBUTING.md

@@ -27,7 +27,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
 
 ## I Have a Question
 
-> If you want to ask a question, we assume that you have read the available [Documentation](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/).
+> If you want to ask a question, we assume that you have read the available [Documentation](https://esa.github.io/polyhedral-gravity-model/).
 
 Before you ask a question, it is best to search for existing [Issues](https://github.com/esa/polyhedral-gravity-model/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
 
@@ -53,7 +53,7 @@ We will then take care of the issue as soon as possible.
 A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
 - Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://esa.github.io/polyhedral-gravity-model/). If you are looking for support, you might want to check [this section](#i-have-a-question)).
 - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [issue board](https://github.com/esa/polyhedral-gravity-modelissues?q=label%3Abug).
 - Collect information about the bug:
   - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
@@ -89,7 +89,7 @@ This section guides you through submitting an enhancement suggestion for Polyhed
 #### Before Submitting an Enhancement
 
 - Make sure that you are using the latest version.
-- Read the [documentation](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/) carefully and find out if the functionality is already covered, maybe by an individual configuration.
+- Read the [documentation](https://esa.github.io/polyhedral-gravity-model) carefully and find out if the functionality is already covered, maybe by an individual configuration.
 - Perform a [search](https://github.com/esa/polyhedral-gravity-model/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
 
@@ -108,7 +108,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/esa/po
 Have you found an issue you would like to work on? Or do you have a great idea for a new feature? Here are some tips to get you started.
 
 - Ensure that you work on a new branch for your contribution. The name does not need to follow a specific pattern, but it should be descriptive (e.g. `fix-issue-123` or `fancy-feature-xyz`).
-- Make sure that you are using the latest version from `main`. Instructions on how to set up the project can be found in the [documentation](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/) or in the [README](README.md).
+- Make sure that you are using the latest version from `main`. Instructions on how to set up the project can be found in the [documentation](https://esa.github.io/polyhedral-gravity-model/) or in the [README](README.md).
 - Please try to follow the existing code style and conventions.
 - Please try to follow the best practices and guidelines for your code's quality and documentation. This includes writing tests for your code. We do not enforce a specific coverage, but we expect reasonable tests for new code.
 - Please try to be short and concise with your commit messages. In case you want to provide more information, you can use the commit description.
@@ -117,7 +117,7 @@ If everything is set-up and your happy with your changes feel free to open a Pul
 
 ### Improving The Documentation
 
-Enhancements to the documentation are always welcome (e.g. new examples, guides, improvement of a method's description, etc.). The documentation is located in the [docs](docs) folder. The documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/). The documentation is hosted on [ReadTheDocs](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/).
+Enhancements to the documentation are always welcome (e.g. new examples, guides, improvement of a method's description, etc.). The documentation is located in the [docs](docs) folder. The documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/). The documentation is hosted on [ReadTheDocs](https://esa.github.io/polyhedral-gravity-model/).
 
 -------------
 

README.md

@@ -68,8 +68,8 @@ Some exemplary results and plots are stored in the
 It also provides a good introduction to the application of
 the python interface.
 
-The full extensive documentation can be found
-on [readthedocs](https://polyhedral-gravity-model-cpp.readthedocs.io/en/stable/).
+The [GitHub Pages](https://esa.github.io/polyhedral-gravity-model) of this project
+contain the full extensive documentation.
 
 ### Minimal Python Example
 
@@ -106,7 +106,7 @@ potential, acceleration, tensor = polyhedral_gravity.evaluate(
 ```
 
 The more advanced way is to use the `GravityEvaluable` class. It caches the
-internal data strcuture and properties which can be reused for multiple
+internal data structure and properties which can be reused for multiple
 evaluations. This is especially useful if you want to compute the gravity
 for multiple computation points, but don't know the "future points" in advance.
 
@@ -200,7 +200,7 @@ all of them are **automatically** set-up via CMake:
 - pybind11 (2.10.4 or compatible), required for the Python interface, but not the C++ standalone
 
 The module will be build using a C++17 capable compiler,
-CMake and ninja-build. Just execute the following command in
+CMake. Just execute the following command in
 the repository root folder:
 
 ```bash

paper/paper.md

@@ -81,7 +81,7 @@ The project is open to contributions via pull requests, with instructions on how
 
 # Usage Instructions
 
-We provide detailed usage instructions in the technical documentation on ReadTheDocs\footnote{\url{https://polyhedral-gravity-model-cpp.readthedocs.io/en/latest/}}. Additionally, a minimal working example is given in the repository readme, and more extensive examples, including a walkthrough over the available options as a *Jupyter* notebook\footnote{\url{https://github.com/esa/polyhedral-gravity-model/blob/main/script/polyhedral-gravity.ipynb}}.
+We provide detailed usage instructions in the technical documentation on the project's GitHub Pages\footnote{\url{https://esa.github.io/polyhedral-gravity-model}}. Additionally, a minimal working example is given in the repository readme, and more extensive examples, including a walkthrough over the available options as a *Jupyter* notebook\footnote{\url{https://github.com/esa/polyhedral-gravity-model/blob/main/script/polyhedral-gravity.ipynb}}.
 
 # References
 

script/polyhedral-gravity.ipynb

@@ -106,7 +106,7 @@
     ")\n",
     "\n",
     "outwards_pointing_normals = gravity_util.check_mesh(cube_vertices, cube_faces)\n",
-    "print(f\"Plane normals point outwards: {outwards_pointing_normals}\")\n"
+    "print(f\"Plane normals point outwards: {outwards_pointing_normals}\")"
    ]
   },
   {
@@ -131,7 +131,7 @@
    "outputs": [],
    "source": [
     "computation_point = [1, 0, 0]  # [m]\n",
-    "density = 1.0  # [kg/m^3]\n"
+    "density = 1.0  # [kg/m^3]"
    ]
   },
   {
@@ -180,9 +180,7 @@
     "print(\"=============Gravity Model Solution=============\")\n",
     "print(\"Potential: {} m^2/s^2\".format(potential))\n",
     "print(\"Acceleration [Vx, Vy, Vz]: {} m/s^2\".format(acceleration))\n",
-    "print(\n",
-    "    \"Second derivative tensor [Vxx, Vyy, Vzz, Vxy, Vxz, Vyz]: {} 1/s^2\".format(tensor)\n",
-    ")\n"
+    "print(\"Second derivative tensor [Vxx, Vyy, Vzz, Vxy, Vxz, Vyz]: {} 1/s^2\".format(tensor))"
    ]
   },
   {
@@ -273,9 +271,7 @@
     }
    ],
    "source": [
-    "mesh_plotting.plot_triangulation(\n",
-    "    cube_vertices, cube_faces, \"The triangulation of the $[-1,1]^3$ cube\"\n",
-    ")\n"
+    "mesh_plotting.plot_triangulation(cube_vertices, cube_faces, \"The triangulation of the $[-1,1]^3$ cube\")"
    ]
   },
   {
@@ -417,9 +413,7 @@
     "X = computation_points[:, 0].reshape(len(VALUES), -1)\n",
     "Y = computation_points[:, 1].reshape(len(VALUES), -1)\n",
     "\n",
-    "mesh_plotting.plot_quiver(\n",
-    "    X, Y, acc_xy, \"Acceleration in $x$ and $y$ direction for $z=0$\", plot_rectangle=True\n",
-    ")\n"
+    "mesh_plotting.plot_quiver(X, Y, acc_xy, \"Acceleration in $x$ and $y$ direction for $z=0$\", plot_rectangle=True)"
    ]
   },
   {
@@ -506,7 +500,7 @@
     "Y = np.arange(-1.0, 1.05, 0.05)\n",
     "\n",
     "computation_points = np.array(np.meshgrid(X, Y, [0])).T.reshape(-1, 3)\n",
-    "gravity_results = evaluable_eros(computation_points)\n"
+    "gravity_results = evaluable_eros(computation_points)"
    ]
   },
   {
@@ -600,9 +594,7 @@
     "acc_xy = np.delete(accelerations, 2, 1)\n",
     "acc_xy = -1 * acc_xy\n",
     "\n",
-    "mesh_plotting.plot_quiver(\n",
-    "    X, Y, acc_xy, \"Acceleration in $x$ and $y$ direction for $z=0$\"\n",
-    ")\n"
+    "mesh_plotting.plot_quiver(X, Y, acc_xy, \"Acceleration in $x$ and $y$ direction for $z=0$\")"
    ]
   },
   {
@@ -652,13 +644,9 @@
     "\n",
     "torus_vertices, torus_faces = mesh_utility.read_pk_file(\"mesh/torus_lp.pk\")\n",
     "density = 1.0\n",
-    "torus_evaluable = gravity_model.GravityEvaluable(\n",
-    "    polyhedral_source=(torus_vertices, torus_faces), density=density\n",
-    ")\n",
+    "torus_evaluable = gravity_model.GravityEvaluable(polyhedral_source=(torus_vertices, torus_faces), density=density)\n",
     "\n",
-    "mesh_plotting.plot_triangulation(\n",
-    "    torus_vertices, torus_faces, \"Triangulation of a Torus\"\n",
-    ")\n"
+    "mesh_plotting.plot_triangulation(torus_vertices, torus_faces, \"Triangulation of a Torus\")"
    ]
   },
   {
@@ -728,7 +716,7 @@
     "\n",
     "fig.set_dpi(200)\n",
     "\n",
-    "plt.show()\n"
+    "plt.show()"
    ]
   },
   {
@@ -783,7 +771,7 @@
    "source": [
     "## Further reference\n",
     "\n",
-    "For additional examples and the full API of the Python Interface (and C++ interface) refer to the [documentation](https://polyhedral-gravity-model-cpp.readthedocs.io/en/latest/).\n"
+    "For additional examples and the full API of the Python Interface (and C++ interface) refer to the [documentation](https://esa.github.io/polyhedral-gravity-model/).\n"
    ]
   }
  ],