From 2996f28f4fb8919af318a8f744e9910ac3cc20d4 Mon Sep 17 00:00:00 2001 From: Caetano Melone Date: Tue, 3 Jun 2025 15:19:42 -0700 Subject: [PATCH 1/4] lint index.rst according to new rules --- index.rst | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/index.rst b/index.rst index a9cd46967e..b63acf29a7 100644 --- a/index.rst +++ b/index.rst @@ -8,14 +8,11 @@ Tutorial: Spack 101 =================== -This is an introduction to Spack with lectures and live demos. It was last presented at -the `Supercomputing 2024 Conference -`_, November -18, 2024. The event was a full-day tutorial. +This is an introduction to Spack with lectures and live demos. +It was last presented at the `Supercomputing 2024 Conference `_, November 18, 2024. +The event was a full-day tutorial. -You can use these materials to teach a course on Spack at your own site, -or you can just skip ahead and read the live demo scripts to see how -Spack is used in practice. +You can use these materials to teach a course on Spack at your own site, or you can just skip ahead and read the live demo scripts to see how Spack is used in practice. .. _slides: @@ -37,8 +34,7 @@ Supercomputing 2024 (SC24), Atlanta, GA, November 18, 2024. .. rubric:: Video -For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version -`_. +For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version `_. .. _live-demos: @@ -47,8 +43,8 @@ For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 versi We provide scripts that take you step-by-step through basic Spack tasks. They correspond to sections in the slides above. -To run through the scripts, we provide the `spack/tutorial `_ -container image. You can invoke +To run through the scripts, we provide the `spack/tutorial `_ container image. +You can invoke .. code-block:: console @@ -66,8 +62,7 @@ to start using the container. You should now be ready to run through our demo sc #. :ref:`binary-cache-tutorial` #. :ref:`spack-scripting-tutorial` -Other sections from past tutorials are also available, although they may -not be kept up-to-date as frequently: +Other sections from past tutorials are also available, although they may not be kept up-to-date as frequently: #. :ref:`modules-tutorial` #. :ref:`build-systems-tutorial` From 1c0fdfa775837e460960855c22f83dad5d156626 Mon Sep 17 00:00:00 2001 From: Caetano Melone Date: Tue, 3 Jun 2025 15:57:47 -0700 Subject: [PATCH 2/4] add all .rst in root to style checK --- .github/workflows/style.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml index 31dc5db4d5..7996e4a536 100644 --- a/.github/workflows/style.yml +++ b/.github/workflows/style.yml @@ -16,4 +16,4 @@ jobs: - name: Run RST Formatter run: | - bin/format_rst_file.py --check tutorial_*.rst + bin/format_rst_file.py --check *.rst From c840791f4ccbc620b1a3f3e9a3dfe7d25962f181 Mon Sep 17 00:00:00 2001 From: Caetano Melone Date: Tue, 3 Jun 2025 15:58:34 -0700 Subject: [PATCH 3/4] add all .rst in root to make format cmd --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f2e453377b..eb0f9e24ea 100644 --- a/Makefile +++ b/Makefile @@ -91,7 +91,7 @@ clean: -rm -rf $(BUILDDIR)/* $(APIDOC_FILES) format: - bin/format_rst_file.py tutorial_*.rst + bin/format_rst_file.py *.rst html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html From 2d9304a2601da09461f46fb8fc1dfb225f0e2b5c Mon Sep 17 00:00:00 2001 From: Caetano Melone Date: Tue, 3 Jun 2025 16:00:32 -0700 Subject: [PATCH 4/4] change gh ci style filter --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 542bee80db..fd9f791b11 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -39,7 +39,7 @@ jobs: - '.github/**' - 'container/**' style: - - 'tutorial_*.rst' + - '*.rst' outputs: - '.github/**' - 'container/**'