Merge branch 'documentation' into documentation

.github/workflows/contributors.yml

@@ -0,0 +1,52 @@
+name: Monthly contributor report
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '3 2 1 * *'
+
+permissions:
+  contents: read
+
+jobs:
+  contributor_report:
+    name: contributor report
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v4
+
+      - name: Get start and end dates
+        shell: bash
+        run: |
+          # Some date before the start of the Herb.jl project
+          start_date=2023-01-01
+  
+          # Calculate the last day of the previous month
+          end_date=$(date -d "$start_date +1 month -1 day" +%Y-%m-%d)
+
+          #Set an environment variable with the date range
+          echo "START_DATE=$start_date" >> "$GITHUB_ENV"
+          echo "END_DATE=$end_date" >> "$GITHUB_ENV"
+
+      - name: Run contributor action
+        uses: github/contributors@v1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          START_DATE: ${{ env.START_DATE }}
+          END_DATE: ${{ env.END_DATE }}          
+          ORGANIZATION: Herb-AI
+          SPONSOR_INFO: "true"
+          LINK_TO_PROFILE: "true"
+
+      - name: Move contributors file to repo directory
+        shell: bash
+        run: mv contibutors.md ${{ github.repository }}/CONTRIBUTORS.md
+
+      - name: Add and commit CONTRIBUTORS.md
+        uses: EndBug/add-and-commit@v9 
+        with:
+          message: "Monthly contributors report"
+          default_author: github_actor

.github/workflows/documentation.yml

@@ -14,6 +14,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --upgrade jupyterlab nbconvert
       - uses: julia-actions/setup-julia@v1
         with:
           version: '1'

Project.toml

@@ -1,7 +1,7 @@
 name = "Herb"
 uuid = "c09c6b7f-4f63-49de-90d9-97a3563c0f4a"
 authors = ["Jaap de Jong <[email protected]>", "Tilman Hinnerichs <[email protected]>", "Sebastijan Dumancic <[email protected]>"]
-version = "0.2.0"
+version = "0.3.0"
 
 [deps]
 HerbConstraints = "1fa96474-3206-4513-b4fa-23913f296dfc"
@@ -13,11 +13,11 @@ HerbSpecification = "6d54aada-062f-46d8-85cf-a1ceaf058a06"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 
 [compat]
-HerbConstraints = "^0.1.1"
-HerbCore = "^0.2.0"
+HerbConstraints = "^0.2.0"
+HerbCore = "^0.3.0"
+HerbGrammar = "^0.3.0"
 HerbInterpret = "^0.1.2"
-HerbGrammar = "^0.2.1"
-HerbSearch = "^0.2.0"
+HerbSearch = "^0.3.0"
 HerbSpecification = "^0.1.0"
 julia = "^1.8"
 

docs/Project.toml

@@ -8,6 +8,7 @@ HerbGrammar = "4ef9e186-2fe5-4b24-8de7-9f7291f24af7"
 HerbInterpret = "5bbddadd-02c5-4713-84b8-97364418cca7"
 HerbSearch = "3008d8e8-f9aa-438a-92ed-26e9c7b4829f"
 HerbSpecification = "6d54aada-062f-46d8-85cf-a1ceaf058a06"
+PyCall = "438e738f-606a-5dbb-bf0a-cddfbfd45ab0"
 
 [compat]
 Documenter = "1"

docs/make.jl

@@ -9,6 +9,18 @@ using HerbInterpret
 using HerbCore
 using HerbSpecification
 
+# Use jupyter.nbconver to convert notebooks to markdown
+using PyCall
+jupyter = pyimport("jupyterlab")
+nbconvert = pyimport("nbconvert")
+all_notebooks = readdir("docs/src/tutorials/")
+for file in all_notebooks
+    if occursin("ipynb", file)
+        path = "docs/src/tutorials/" *  file
+        run(`jupyter nbconvert --to markdown $path`)
+    end
+end
+
 makedocs(
     modules=[HerbConstraints, HerbSearch, HerbGrammar, HerbSpecification, HerbInterpret, HerbCore],
     authors="PONYs",
@@ -24,7 +36,9 @@ makedocs(
             "A more verbose getting started with Herb.jl" => "tutorials/getting_started_with_herb.md",
             "Defining Grammars in Herb.jl" => "tutorials/defining_grammars.md",
             "Advanced Search Procedures" => "tutorials/advanced_search.md"
-            "Top Down Iterator" => "tutorials/TopDown.md"
+            "Top Down Iterator" => "tutorials/TopDown.md",
+            "Getting started with Constraints" => "tutorials/getting_started_with_constraints.md",
+            "Working with custom interpreters" => "tutorials/working_with_interpreters.md"
         ],
         "Sub-Modules" => [
             "HerbCore.jl" => "HerbCore/index.md",