Skip to content

Conversation

haampie
Copy link
Member

@haampie haampie commented Sep 2, 2025

  • Fix Google Analytics token. Currently it's using the one from spack.readthedocs.io, which means the analytics from our docs are unreliable
  • Ensure conf.py is in sync with spack/spack
  • Use the same formatter as in spack/spack
  • Fix a typo
  • Fix Python/YAML style, and fix a few syntax errors related to it
  • Fix includes of build system modules
  • Fix include of a command output
  • Enable warning = error to avoid issues in the future...

Signed-off-by: Harmen Stoppels <me@harmenstoppels.nl>
Signed-off-by: Harmen Stoppels <me@harmenstoppels.nl>
Signed-off-by: Harmen Stoppels <me@harmenstoppels.nl>
Signed-off-by: Harmen Stoppels <me@harmenstoppels.nl>
@haampie haampie changed the title fix google analytics, sync config with spack/spack Various fixes Sep 2, 2025
@haampie haampie requested a review from Copilot September 2, 2025 12:15
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR applies various fixes to ensure the documentation is in sync with the main Spack repository and resolves formatting, style, and configuration issues.

  • Fixes Google Analytics token to use tutorial-specific tracking instead of conflating with spack.readthedocs.io
  • Updates conf.py configuration to match spack/spack and adds custom HTML formatter
  • Applies consistent RST formatting throughout documentation files

Reviewed Changes

Copilot reviewed 19 out of 23 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
_templates/base.html Updates Google Analytics tracking ID from shared to tutorial-specific
conf.py Synchronizes configuration with spack/spack, adds custom HTML formatter, and updates extensions
.readthedocs.yaml Enables fail_on_warning and adds post_checkout job for accurate timestamps
.gitmodules Adds _spack_packages submodule reference
_spack_packages Adds submodule commit reference
.github/workflows/style.yml Updates style check workflow to install dependencies and use proper file selection
tutorial_*.rst files Applies consistent RST formatting by breaking long lines and fixing indentation
common/setup.rst Applies line formatting fixes
index.rst Applies line formatting fixes
Comments suppressed due to low confidence (1)

conf.py:1

  • The path appears to have an extra '/base' directory. Should be _spack_root/etc/spack/defaults/packages.yaml based on standard Spack directory structure.
# Copyright Spack Project Developers. See COPYRIGHT file for details.

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Member

@alalazo alalazo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly LGTM, only a couple minor comments.

The notes at the top, with nested boxes, don't render very well:
Screenshot from 2025-09-02 14-24-13

alalazo
alalazo previously approved these changes Sep 2, 2025
@haampie haampie force-pushed the hs/fix/token branch 2 times, most recently from ca70e19 to c627c76 Compare September 2, 2025 14:41
@haampie haampie merged commit 10c9fcb into main Sep 2, 2025
4 of 5 checks passed
@haampie haampie deleted the hs/fix/token branch September 2, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants