Skip to content

adding in an rst linter #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
laurenchilutti wants to merge 11 commits into
base: main
Choose a base branch
from
Open

adding in an rst linter #796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7fc7487
adding in an rst linter
laurenchilutti Mar 25, 2026
692639d
modiy lint workflow - it had a copy paste error
laurenchilutti Mar 25, 2026
81f314c
Merge remote-tracking branch 'origin/main' into rstlint
laurenchilutti Apr 13, 2026
ea26f6f
Merge remote-tracking branch 'origin/main' into rstlint
laurenchilutti Jun 23, 2026
834f8a7
updating pyproject yaml to build doc8 for rst linting as an optional …
laurenchilutti Jun 23, 2026
92b5848
updating rst_lint CI to use python 3.11 to hopefully get pst a catalo…
laurenchilutti Jun 23, 2026
f9de166
reference 2026.01.01 version of catalogbuilder in rst_lint pip install
laurenchilutti Jun 23, 2026
028efa8
Refactor RST lint workflow to avoid full docs build
laurenchilutti Jun 24, 2026
a2a6827
Update lint workflow to remove working-directory
laurenchilutti Jun 24, 2026
eaf6b4c
Merge branch 'main' into rstlint
ceblanton Jul 14, 2026
0028a1b
Merge branch 'main' into rstlint
singhd789 Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/rst_lint.yml
View file
Open in desktop

@ilaflott ilaflott Jun 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this could actually be even more minimal, avoiding cloning CatalogBuilder-

steps:
      - name: Code Checkout
        uses: actions/checkout@v4
        
      - name: Prepare Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
          cache: 'pip'
          
      - name: Install doc8
        run: pip install doc8
        
      - name: Lint RST files
        working-directory: ./fre-cli
        run: doc8 *

Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: reStructuredText Lint
on:
push:
branches:
- 'main'
pull_request:

jobs:
run_lint:
runs-on: ubuntu-latest
steps:
- name: Code Checkout
uses: actions/checkout@v4
- name: Prepare Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install Python Requirements
run: pip install doc8
- name: Lint RST files
run: doc8 *
1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ docs = [
"sphinx",
"renku-sphinx-theme",
"sphinx-rtd-theme",
"doc8",
]

test = [
Expand Down
Loading