diff --git a/.github/styles/Vocab/Mautic/accept.txt b/.github/styles/config/vocabularies/Mautic/accept.txt similarity index 100% rename from .github/styles/Vocab/Mautic/accept.txt rename to .github/styles/config/vocabularies/Mautic/accept.txt diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index 523c50c5..60113cd2 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -1,25 +1,29 @@ name: Linting on: - # Note: onlyAnnotateModifiedLines only works correctly on PRs! - # If you need to run checks on push as well, create a separate workflow file. pull_request: jobs: prose: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 with: fetch-depth: 0 + - uses: actions/setup-python@v4 + with: + python-version: '3.x' + cache: 'pip' + + - name: Install Python dependencies + run: pip3 install -r docs/requirements.txt + - name: Vale - uses: errata-ai/vale-action@master + uses: errata-ai/vale-action@reviewdog with: - # We can modify these styles as we want - styles: | - https://github.com/errata-ai/Google/releases/latest/download/Google.zip - onlyAnnotateModifiedLines: true + # Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience + version: 3.7.1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -27,9 +31,9 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v4 - - uses: actions/setup-python@v2 + - uses: actions/setup-python@v4 with: python-version: '3.x' cache: 'pip' @@ -43,4 +47,4 @@ jobs: - name: Check links working-directory: docs - run: make checklinks + run: make checklinks \ No newline at end of file diff --git a/.gitpod.yml b/.gitpod.yml index 0ca4e4d5..bdc51320 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,5 +1,3 @@ -# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily -# use this once which has Python 3.9 and Vale preinstalled. image: file: .gitpod.Dockerfile @@ -13,23 +11,4 @@ vscode: - lextudio.restructuredtext@190.1.4 # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading. - trond-snekvik.simple-rst - errata-ai.vale-server - - eamodio.gitlens - -github: - prebuilds: - # enable for the master/default branch (defaults to true) - master: true - # enable for all branches in this repo (defaults to false) - branches: true - # enable for pull requests coming from this repo (defaults to true) - pullRequests: true - # enable for pull requests coming from forks (defaults to false) - pullRequestsFromForks: true - # add a check to pull requests (defaults to true) - addCheck: false - # add a "Review in Gitpod" button as a comment to pull requests (defaults to false) - addComment: false - # add a "Review in Gitpod" button to the pull request's description (defaults to false) - addBadge: true - # add a label once the prebuild is ready to pull requests (defaults to false) - addLabel: false + - eamodio.gitlens \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 416e26bf..bc463c39 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-20.04 tools: - python: "3.9" + python: "3.11" # You can also specify other tool versions: # nodejs: "16" # rust: "1.55" diff --git a/docs/requirements.txt b/docs/requirements.txt index 94b8ed29..beceeb66 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,11 +1,11 @@ # File: requirements.txt # Defining the exact version will make sure things don't break -sphinx==6.2.1 -sphinx_rtd_theme==1.2.0 +sphinx==8.0.2 +sphinx_rtd_theme==3.0.0 readthedocs-sphinx-search==0.3.2 -rstcheck==6.1.1 -myst-parser==1.0.0 -linkify-it-py==2.0.0 +rstcheck==6.2.4 +myst-parser==4.0.0 +linkify-it-py==2.0.3 esbonio==0.16.5 -attrs==22.2.0 +attrs==24.2.0 \ No newline at end of file