Skip to content

Commit 0793325

Browse files
authored
format index.rst according to new rules (#445)
* lint index.rst according to new rules * add all .rst in root to style checK * add all .rst in root to make format cmd * change gh ci style filter
1 parent 187a295 commit 0793325

4 files changed

Lines changed: 11 additions & 16 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
- '.github/**'
4040
- 'container/**'
4141
style:
42-
- 'tutorial_*.rst'
42+
- '*.rst'
4343
outputs:
4444
- '.github/**'
4545
- 'container/**'

.github/workflows/style.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ jobs:
1616

1717
- name: Run RST Formatter
1818
run: |
19-
bin/format_rst_file.py --check tutorial_*.rst
19+
bin/format_rst_file.py --check *.rst

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ clean:
9191
-rm -rf $(BUILDDIR)/* $(APIDOC_FILES)
9292

9393
format:
94-
bin/format_rst_file.py tutorial_*.rst
94+
bin/format_rst_file.py *.rst
9595

9696
html:
9797
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

index.rst

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,11 @@
88
Tutorial: Spack 101
99
===================
1010

11-
This is an introduction to Spack with lectures and live demos. It was last presented at
12-
the `Supercomputing 2024 Conference
13-
<https://sc24.conference-program.com/presentation/?id=tut182&sess=sess422>`_, November
14-
18, 2024. The event was a full-day tutorial.
11+
This is an introduction to Spack with lectures and live demos.
12+
It was last presented at the `Supercomputing 2024 Conference <https://sc24.conference-program.com/presentation/?id=tut182&sess=sess422>`_, November 18, 2024.
13+
The event was a full-day tutorial.
1514

16-
You can use these materials to teach a course on Spack at your own site,
17-
or you can just skip ahead and read the live demo scripts to see how
18-
Spack is used in practice.
15+
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.
1916

2017
.. _slides:
2118

@@ -37,8 +34,7 @@ Supercomputing 2024 (SC24), Atlanta, GA, November 18, 2024.
3734

3835
.. rubric:: Video
3936

40-
For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version
41-
<https://spack-tutorial.readthedocs.io/en/hpcic24/>`_.
37+
For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 version <https://spack-tutorial.readthedocs.io/en/hpcic24/>`_.
4238

4339
.. _live-demos:
4440

@@ -47,8 +43,8 @@ For the last recorded video of this tutorial, see the `HPCIC Tutorial 2024 versi
4743
We provide scripts that take you step-by-step through basic Spack tasks.
4844
They correspond to sections in the slides above.
4945

50-
To run through the scripts, we provide the `spack/tutorial <https://ghcr.io/spack/tutorial>`_
51-
container image. You can invoke
46+
To run through the scripts, we provide the `spack/tutorial <https://ghcr.io/spack/tutorial>`_ container image.
47+
You can invoke
5248

5349
.. code-block:: console
5450
@@ -66,8 +62,7 @@ to start using the container. You should now be ready to run through our demo sc
6662
#. :ref:`binary-cache-tutorial`
6763
#. :ref:`spack-scripting-tutorial`
6864

69-
Other sections from past tutorials are also available, although they may
70-
not be kept up-to-date as frequently:
65+
Other sections from past tutorials are also available, although they may not be kept up-to-date as frequently:
7166

7267
#. :ref:`modules-tutorial`
7368
#. :ref:`build-systems-tutorial`

0 commit comments

Comments
 (0)