Reformat RST files for better diffs (#431)

Author: alecbcs

.github/workflows/ci.yml

@@ -22,6 +22,7 @@ jobs:
     outputs:
       container: ${{ steps.filter.outputs.container }}
       outputs: ${{ steps.filter.outputs.outputs }}
+      style: ${{ steps.filter.outputs.style }}
 
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # @v2
@@ -37,6 +38,8 @@ jobs:
             container:
               - '.github/**'
               - 'container/**'
+            style:
+              - 'tutorial_*.rst'
             outputs:
               - '.github/**'
               - 'container/**'
@@ -47,12 +50,17 @@ jobs:
     needs: changes
     uses: ./.github/workflows/container.yml
 
-  outputs:
-    if: |
-      always()
-      && contains(needs.*.result, 'success')
-      && !contains(needs.*.result, 'failure')
-      && (needs.changes.outputs.outputs == 'true'
-      || startsWith(github.ref, 'refs/tags/'))
-    needs: [ changes, container ]
-    uses: ./.github/workflows/outputs.yml
+  # outputs:
+  #   if: |
+  #     !cancelled()
+  #     && contains(needs.*.result, 'success')
+  #     && !contains(needs.*.result, 'failure')
+  #     && (needs.changes.outputs.outputs == 'true'
+  #     || startsWith(github.ref, 'refs/tags/'))
+  #   needs: [ changes, container ]
+  #   uses: ./.github/workflows/outputs.yml
+
+  style:
+    if: ${{ needs.changes.outputs.style == 'true' }}
+    needs: changes
+    uses: ./.github/workflows/style.yml

.github/workflows/style.yml

@@ -0,0 +1,19 @@
+name: Linting & Style Checks
+on:
+  workflow_call:
+
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+
+      - name: Set up Python
+        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55
+        with:
+          python-version: '3.13'
+
+      - name: Run RST Formatter
+        run: |
+          bin/format_rst_file.py --check tutorial_*.rst

Makefile

@@ -90,6 +90,9 @@ clean:
 	-rm -f command_index.rst
 	-rm -rf $(BUILDDIR)/* $(APIDOC_FILES)
 
+format:
+	bin/format_rst_file.py tutorial_*.rst
+
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
@@ -119,13 +122,13 @@ htmlhelp:
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+		  ".hhp project file in $(BUILDDIR)/htmlhelp."
 
 qthelp:
 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+		  ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Spack.qhcp"
 	@echo "To view the help file:"
 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Spack.qhc"
@@ -149,7 +152,7 @@ latex:
 	@echo
 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
+		  "(use \`make latexpdf' here to do that automatically)."
 
 latexpdf:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@@ -172,7 +175,7 @@ texinfo:
 	@echo
 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
 	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
+		  "(use \`make info' here to do that automatically)."
 
 info:
 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@@ -194,12 +197,12 @@ linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
+		  "or in $(BUILDDIR)/linkcheck/output.txt."
 
 doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
+		  "results in $(BUILDDIR)/doctest/output.txt."
 
 dashdoc:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/dashdoc