epic: provide central develop page (#49)

* build: split requirements for dev extras (#43) * ci: add workflow for epic branches (#36) * ci: add note on sphinx-autobuild and tox sphinx-autobuild job (#47) * ci: ignore build folder for markdownlint * ci: ignore error message code-block * ci: limit Conda to Python <3.9 * fix: remove duplicate black requirement * fix: remove test job from CD * fix: reST indentation in branching page * docs: upgrade to Sphinx Book Theme 0.39 (#37) * chore: convert develop page to MyST (#41) * ci: use installed packages for pre-commit (#45) * ci: upgrate pre-commit * docs: reformulate develop page in general terms (#46)
ComPWA · Nov 19, 2020 · d070976 · d070976
1 parent 9d0f501
commit d070976
Show file tree

Hide file tree

Showing 17 changed files with 791 additions and 452 deletions.
diff --git a/.github/workflows/cd.yml b/.github/workflows/cd.yml
@@ -8,36 +8,6 @@ on:
       - "[0-9]+.[0-9]+.[0-9]+*"
 
 jobs:
-  test:
-    name: Run pytest
-    if: startsWith(github.ref, 'refs/tags')
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os:
-          - macos-10.15
-          - ubuntu-18.04
-        python-version: [3.6, 3.7, 3.8]
-        exclude:
-          - os: macos-10.15
-            python-version: 3.6
-          - os: macos-10.15
-            python-version: 3.8
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install .[test]
-      - name: Test with pytest
-        env:
-          PYTEST_RUN_SLOW_TESTS: YES
-        run: pytest -n auto
-
   documentation:
     name: Build documentation and run notebooks
     if: startsWith(github.ref, 'refs/tags')
@@ -75,7 +45,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install .[dev]
+          pip install .[ci]
           sudo npm install -g cspell markdownlint-cli pyright
       - name: Perform style checks
         run: tox -e sty
@@ -93,7 +63,6 @@ jobs:
     needs:
       - documentation
       - style
-      - test
     steps:
       - uses: actions/checkout@master
       - name: Push to stable branch

diff --git a/.github/workflows/ci-epic.yml b/.github/workflows/ci-epic.yml
@@ -0,0 +1,44 @@
+name: CI for epics
+
+on:
+  push:
+    branches:
+      - epic/*
+  pull_request:
+    branches:
+      - epic/*
+
+jobs:
+  documentation:
+    name: Build documentation and run notebooks
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[doc]
+          sudo apt-get -y install pandoc graphviz
+      - name: Build documentation and run notebooks
+        working-directory: docs
+        run: make html
+
+  style:
+    name: Style checks
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[ci]
+      - name: Perform style checks
+        run: tox -e sty
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -46,7 +46,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install .[dev]
+          pip install .[ci]
           sudo npm install -g cspell markdownlint-cli pyright
       - name: Perform style checks
         run: tox -e sty

diff --git a/.github/workflows/pr-linting.yml b/.github/workflows/pr-linting.yml
@@ -21,7 +21,7 @@ jobs:
           any_of: |
             Bug,💡 Enhancement,📝 Docs,🔨 Maintenance,🖱️ DX,📖 Analysis,
             📖 Software,📖 Theory
-          none_of: Epic,❌ Won't fix,💫 Good first issue
+          none_of: ❌ Won't fix,💫 Good first issue
           repo_token: ${{ secrets.GITHUB_TOKEN }}
 
   check-title:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,23 +25,6 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
 
-  - repo: https://github.com/psf/black
-    rev: 20.8b1
-    hooks:
-      - id: black
-
-  - repo: https://github.com/PyCQA/doc8
-    rev: 0.8.1
-    hooks:
-      - id: doc8
-        args: ["-q"]
-
-  - repo: https://github.com/kynan/nbstripout
-    rev: 0.3.8
-    hooks:
-      - id: nbstripout
-        files: ".ipynb"
-
   - repo: https://github.com/prettier/prettier
     rev: 2.1.2
     hooks:
@@ -50,6 +33,21 @@ repos:
 
   - repo: local
     hooks:
+      - id: black
+        name: black
+        entry: black
+        language: system
+        types:
+          - python
+
+      - id: doc8
+        name: doc8
+        entry: doc8
+        args:
+          - -q
+        language: system
+        files: \.(inc|rst)$
+
       - id: flake8
         name: flake8
         entry: flake8
@@ -71,6 +69,13 @@ repos:
         types:
           - python
 
+      - id: nbstripout
+        name: nbstripout
+        entry: nbstripout
+        language: system
+        types:
+          - jupyter
+
       - id: pydocstyle
         name: pydocstyle
         entry: pydocstyle
@@ -80,7 +85,10 @@ repos:
 
       - id: pylint
         name: pylint
-        entry: pylint --rcfile=.pylintrc --score=no
+        entry: pylint
+        args:
+          - --rcfile=.pylintrc
+          - --score=no
         language: system
         types:
           - python

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -12,7 +12,8 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "[markdown]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.wordWrap": "off"
   },
   "[python]": {
     "editor.codeActionsOnSave": {
@@ -56,6 +57,5 @@
   "restructuredtext.confPath": "${workspaceFolder}/doc",
   "rewrap.wrappingColumn": 79,
   "telemetry.enableCrashReporter": false,
-  "telemetry.enableTelemetry": false,
-  "restructuredtext.confPath": "${workspaceFolder}/doc"
+  "telemetry.enableTelemetry": false
 }
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -9,6 +9,7 @@ module.exports = {
         "ci",
         "chore",
         "docs",
+        "epic",
         "feat",
         "fix",
         "refactor",

diff --git a/cspell.json b/cspell.json
@@ -91,6 +91,7 @@
         "mkdir",
         "modindex",
         "multiplets",
+        "mypy",
         "nbconvert",
         "nbformat",
         "nbstripout",
@@ -120,6 +121,7 @@
         "treiman",
         "unbinned",
         "unsrt",
+        "venv",
         "xlabel",
         "ylabel"
     ]

diff --git a/docs/conf.py b/docs/conf.py
@@ -104,6 +104,7 @@
     "repository_branch": "stable",
     "path_to_docs": "docs",
     "use_edit_page_button": True,
+    "use_download_button": True,
     "use_issues_button": True,
     "use_repository_button": True,
     "launch_buttons": {
@@ -113,7 +114,6 @@
         "thebe": True,
         "thebelab": True,
     },
-    "expand_sections": ["theory"],
     "theme_dev_mode": True,
 }
 html_title = "Partial Wave Analysis"
@@ -155,6 +155,7 @@
 # Settings for linkcheck
 linkcheck_anchors = False
 linkcheck_ignore = [
+    "http://127.0.0.1:8000",
     r"https://isbnsearch.org/isbn/\d+",
 ]
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ module.exports = { @@
             "ci",
             "chore",
             "docs",
+            "epic",
             "feat",
             "fix",
             "refactor",
@@ Expand Down @@