From aacff9eab773348754eb998beeb811249d36dcd7 Mon Sep 17 00:00:00 2001 From: Hans Fangohr <hans.fangohr@mpsd.mpg.de> Date: Thu, 22 Jun 2023 17:25:02 +0200 Subject: [PATCH 1/2] fix rst style rstcheck README.rst now passes. --- README.rst | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 05ddf0f..7a2383a 100644 --- a/README.rst +++ b/README.rst @@ -36,14 +36,6 @@ To install, for example, the ``foss2022a-serial`` toolchain: Future calls of the `mpsd-software` command need to be executed from this "mpsd-software-root" directory. -.. comment: - 3. Initiate the installation at this location using:: - - $ mpsd-software init - - (This creates a hidden file ``.mpsd-software-root`` to tag the location for - as the root of the installation. All compiled files, logs etc are written in - or below this subdirectory.) 3. From the same directory, run the command to install the ``foss2022a-serial`` toolchain:: @@ -252,3 +244,15 @@ Frequently asked questions Development ----------- Developers documentation is available at development.rst. + + +.. comment: + Draft for additional steps for 'quickstart' once/if we have the the `init` command added. + + 3. Initiate the installation at this location using:: + + $ mpsd-software init + + (This creates a hidden file ``.mpsd-software-root`` to tag the location for + as the root of the installation. All compiled files, logs etc are written in + or below this subdirectory.) -- GitLab From 290febe53d0999272728b80d96a9d88a22effa5b Mon Sep 17 00:00:00 2001 From: iamashwin99 <ashwin-kumar.karnad@mpsd.mpg.de> Date: Thu, 22 Jun 2023 17:28:37 +0200 Subject: [PATCH 2/2] remove the reduction in rstcheck verbosity --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 00e5c86..ba43b69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -61,5 +61,5 @@ repos: - sphinx==4.5.0 - sphinx-click==3.1.0 args: [ - --report-level=WARNING, + --report-level=INFO, ] -- GitLab