Merge pull request #313 from ImperialCollegeLondon/joss-paper

Joss paper

.github/workflows/check-links.yml

@@ -13,3 +13,4 @@ jobs:
         with:
           use-quiet-mode: 'yes'
           use-verbose-mode: 'yes'
+          config-file: .markdown-link-check.json

.github/workflows/publish.yml

@@ -73,9 +73,29 @@ jobs:
     - name: Publish package distributions to PyPI
       uses: pypa/gh-action-pypi-publish@release/v1
 
+  paper:
+    runs-on: ubuntu-latest
+    needs: publish-PyPI
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: docs/paper/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: docs/paper/paper.pdf
 
   publish-docs:
-    needs: publish-PyPI
+    needs: paper
     runs-on: ubuntu-latest
 
     steps:

.markdown-link-check.json

@@ -0,0 +1,7 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": ".*/paper.pdf"
+    }
+  ]
+}

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
     rev: v0.42.0
     hooks:
       - id: markdownlint
-        args: ["--disable", "MD013", "--"]
+        args: ["--disable", "MD013", "--disable", "MD025", "--"]
 
   - repo: https://github.com/codespell-project/codespell
     rev: v2.3.0

docs/index.md

@@ -6,6 +6,7 @@ derive a synthetic urban drainage network anywhere in the world.
 ## Table of contents
 <!-- markdownlint-disable MD007 -->
 - [Home](index.md)
+- [About](./paper/paper.pdf)
 - [Quickstart](quickstart.md)
 - Guides:
     - [Configuration file](config_guide.md)
@@ -24,4 +25,5 @@ derive a synthetic urban drainage network anywhere in the world.
     - [Post processing](reference-post-processing.md)
     - [Preprocessing](reference-preprocessing.md)
     - [Config](reference-defs.md)
-<!---  - [Coverage report](coverage.md)--->
+- [Coverage report](https://app.codecov.io/gh/ImperialCollegeLondon/SWMManywhere)
+<!---  --->