From 5eb134dccd9b94d7bf2c71512d63e6b62d178b7a Mon Sep 17 00:00:00 2001 From: Alexandru Fikl Date: Mon, 8 Jul 2024 22:24:52 +0300 Subject: [PATCH] docs: update links and redirects --- doc/faq.rst | 5 +++-- doc/index.rst | 8 ++++---- doc/installation.rst | 14 +++++++------- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 11e71b8..dad175a 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -55,7 +55,7 @@ references, can be found in the comments at the beginning of the triangle.c source file. Another listing of these references, with PostScript copies of some of the papers, is available from the Web page -http://www.cs.cmu.edu/~quake/triangle.research.html +https://www.cs.cmu.edu/~quake/triangle.research.html These programs may be freely redistributed under the condition that the copyright notices (including the copy of this notice in the code comments @@ -90,5 +90,6 @@ fee. Please send corresponding requests to: tetgen@wias-berlin.de. Please do not forget to include some description of your company and the realm of its activities. -For details, see the `TetGen web page `_ +For details, see the +`TetGen web page `__ diff --git a/doc/index.rst b/doc/index.rst index f6bd2f9..2b298e6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,14 +20,14 @@ also have many other applications ranging from computer graphics to robotics. In order to generate these 2D and 3D meshes, MeshPy provides Python interfaces to a few well-regarded mesh generators: -* `Triangle `__ by J. Shewchuk. -* `TetGen `__ by Hang Si. +* `Triangle `__ by J. Shewchuk. +* `TetGen `__ by Hang Si. Triangle and TetGen are included in the package in slightly modified versions. An interface for `Gmsh `__ was also part of MeshPy, but is now its own package `gmsh_interop `__. -MeshPy has its own `web page `_, +MeshPy has its own `web page `_, where you can find updated software, news, a forum, and documentation. Show me! I need examples! @@ -63,7 +63,7 @@ As a result of this, you will get:: ... and a file :file:`test.vtk` that you can view with -`Paraview `__ or +`Paraview `__ or `Visit `__. Indices and tables diff --git a/doc/installation.rst b/doc/installation.rst index 5963b2c..7c6e0f6 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -7,18 +7,18 @@ This tutorial will walk you through the process of building MeshPy. To follow, you really only need three basic things: * A UNIX-like machine with web access. -* A working `Python `__ installation. -* A recent C++ compiler. We use `pybind11 `__ +* A working `Python `__ installation. +* A recent C++ compiler. We use `pybind11 `__ to create the wrappers, so see their documentation for minimal required versions if in doubt. -* `meson-python `__ and +* `meson-python `__ and `ninja `__, which are used to build the wrapper. See the `[buildsystem]` section in `pyproject.toml` for an up to date list. Step 1: Download and unpack MeshPy ------------------------------------ +---------------------------------- -`Download MeshPy `_ and unpack it:: +`Download MeshPy `_ and unpack it:: $ tar xfz MeshPy-VERSION.tar.gz @@ -29,8 +29,8 @@ If you're downloading from ``git`` instead:: Step 2: Build MeshPy -------------------- -MeshPy uses `meson-python `__ as its build -system. For additional compilation options (e.g. compiling in debug mode), +MeshPy uses `meson-python `__ as +its build system. For additional compilation options (e.g. compiling in debug mode), see their official documentation. First, just type::