Introducing sphinx-lint (#60)

egeakman · web-flow · commit b80694614e2a · 2022-12-01T22:27:08.000+03:00
* Test sphinx-lint

* Update CI

* Update CI

* Update CI

* Update CI
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,36 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - "**"
+  pull_request:
+
+jobs:
+  test:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set Up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Get CPython
+        run: |
+          git clone https://github.com/python/cpython.git ../cpython --branch=3.10
+          
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y gettext 
+          python -m pip install -r requirements.txt
+          python -m pip install -r ../cpython/Doc/requirements.txt
+      
+      - name: Sphinx lint
+        run: |
+          sphinx-lint *.po */*.po
+
+      - name: Build docs
+        run: |
+          PYTHONWARNINGS=ignore::FutureWarning,ignore::RuntimeWarning sphinx-build -j auto -W --keep-going -b html -d ../cpython/Doc/_build/doctree -D language=tr . ../cpython/Doc/_build/html
diff --git a/.github/workflows/get-changes.py b/.github/workflows/get-changes.py
diff --git a/.github/workflows/wrap_branch.yml b/.github/workflows/wrap_branch.yml
@@ -5,26 +5,16 @@ on: workflow_dispatch
 jobs: 
   wrap:
     runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        # Run in all these versions of Python
-        python-version: ["3.10"]
-
     steps:
         # Checkout the latest code from the repo
       - name: Checkout repo
         uses: actions/checkout@v3
 
         # Setup which version of Python to use
-      - name: Set Up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - name: Set Up Python 3.10
+        uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
-
-        # Display the Python version being used
-      - name: Display Python version
-        run: python -c "import sys; print(sys.version)"
+          python-version: "3.10"
 
         # Update pip
       - name: Update pip
@@ -36,11 +26,15 @@ jobs:
 
         # Install dependencies
       - name: Install dependencies
-        run: sudo apt install gettext
+        run: sudo apt install -y gettext
 
         # Wrap all po files
       - name: Wrap
-        run: powrap *.po **/*.po
+        run: powrap *.po */*.po
+
+      - name: Sphinx lint
+        run: |
+          sphinx-lint *.po */*.po
         
         # Detect changed files
       - name: Detect changed files
diff --git a/.github/workflows/wrap_pr.yml b/.github/workflows/wrap_pr.yml
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ __pycache__/
 .DS_Store
 *.pot
 *.po.bak
+locales/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,9 @@
+repos:
+-   repo: local
+    hooks:
+    -   id: lint
+        name: Run sphinx linting
+        entry: sphinx-lint
+        language: python
+        additional_dependencies: ['sphinx-lint==0.6.7']
+        files: \.po$
diff --git a/requirements.txt b/requirements.txt
@@ -4,3 +4,4 @@ sphinx==4.5.0
 blurb
 sphinx-lint==0.6.7
 python-docs-theme>=2022.1
+pre-commit
