From 10cc7fb5e3e67b9ccaf75f912af9b79c4fb6409e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yaman=20G=C3=BC=C3=A7l=C3=BC?= Date: Wed, 5 Mar 2025 12:53:04 +0100 Subject: [PATCH] Fix formatting of README.rst Fixes this error: ``` ERROR `long_description` has syntax errors in markup and would not be rendered on PyPI. line 17: Warning: Title underline too short. Installation ******* ``` --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 4dcdf050..1d4f0496 100644 --- a/README.rst +++ b/README.rst @@ -14,10 +14,10 @@ An example of use can be found in psydac_ or gelato_. Installation -******* +************ Set up a virtual environment -^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We always recommend working in a Python virtual environment. To create a new one we recommend the venv_ package:: @@ -34,7 +34,7 @@ In order to activate the environment from a new terminal session just run the co source /bin/activate Option 1: Install from PyPI -^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Make sure that the preferred virtual environment is activated. Then simply run :: @@ -45,7 +45,7 @@ This will download the correct version of SymPDE from PyPI_ and install it in th .. _PyPI: https://pypi.org/project/sympde/ Option 2: Install from sources -^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ First, clone the repository with Git to download the source files, and change the current directory::