diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yaml similarity index 100% rename from .github/workflows/docs.yml rename to .github/workflows/docs.yaml diff --git a/.github/workflows/links.yml b/.github/workflows/links.yaml similarity index 96% rename from .github/workflows/links.yml rename to .github/workflows/links.yaml index 57ee45f8a..b6da3850c 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yaml @@ -20,7 +20,7 @@ jobs: uses: actions/checkout@v6 - name: Setup Python - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: python-version: '3.12' cache: 'pip' diff --git a/.github/workflows/mdformat.yml b/.github/workflows/mdformat.yaml similarity index 100% rename from .github/workflows/mdformat.yml rename to .github/workflows/mdformat.yaml diff --git a/.github/workflows/ruff.yaml b/.github/workflows/ruff.yaml new file mode 100644 index 000000000..7ba116bc1 --- /dev/null +++ b/.github/workflows/ruff.yaml @@ -0,0 +1,32 @@ +name: Ruff + +on: + push: + branches: [main] + pull_request: + branches: [main] + +permissions: + contents: read + +jobs: + ruff: + name: Check for style errors and common problems + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Set up Python + uses: actions/setup-python@v6 + with: + python-version: "3.12" + + - name: Install Ruff + run: | + python -m pip install --upgrade pip + pip install ruff>=0.8.0 + + - name: Run Ruff linter + run: | + ruff check . \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 11f65df5a..83c92e236 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -38,7 +38,7 @@ html_js_files = ["gh_icon_fix.js"] # Add logo -html_logo = "assets/images/croppedWideLogo.png" +html_logo = "source/_static/images/croppedWideLogo.png" # Furo theme options html_theme_options = { diff --git a/docs/index.rst b/docs/index.rst index 704319751..bcfceaad3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ -HED Python Tools Documentation -================================= +HED Python tools +================ -Welcome to the HED Python Tools documentation. This package provides comprehensive tools for working with Hierarchical Event Descriptors (HED) in Python. +Welcome to the HED Python tools documentation. This package provides comprehensive tools for working with Hierarchical Event Descriptors (HED) in Python. .. toctree:: :maxdepth: 2 diff --git a/docs/assets/images/croppedWideLogo.png b/docs/source/_static/images/croppedWideLogo.png similarity index 100% rename from docs/assets/images/croppedWideLogo.png rename to docs/source/_static/images/croppedWideLogo.png