JOSS paper (#23)

Doc for JOSS:
https://joss.readthedocs.io/en/latest/submitting.html#example-paper-and-bibliography

---------

Co-authored-by: gnopik <[email protected]>
Co-authored-by: Matt Graham <[email protected]>

Author: 3 people

.github/workflows/joss_paper.yml

@@ -0,0 +1,24 @@
+
+on: [push]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - 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: joss/paper.md
+      - name: Upload
+        uses: actions/upload-artifact@v1
+        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: joss/paper.pdf

.gitignore

@@ -32,5 +32,6 @@ htmlcov/*
 build/*
 dist/*
 sdist/*
-docs/_build
+docs/html
+docs/jupyter_execute
 app.html

Makefile

@@ -29,8 +29,11 @@ prepare:  ## Install dependencies and pre-commit hook
 
 # Doc and tests
 
-doc:  ## Build Sphinx documentation
-	sphinx-build -b html docs docs/html
+clean-doc:
+	rm -rf docs/html docs/jupyter_execute
+
+doc: clean-doc  ## Build Sphinx documentation
+	sphinx-build -b html docs docs/html;open docs/html/index.html
 
 test:  ## Run tests with coverage
 	pytest --cov simdec --cov-report term-missing

docs/_static/simdec_presentation.png

@@ -12,6 +12,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "numpydoc",
+    "myst_nb",
 ]
 
 templates_path = ["_templates"]
@@ -21,6 +22,10 @@
 
 autosummary_generate = True
 
+# -- Notebook tutorials with MyST-NB ------------------------------------------
+
+nb_execution_mode = "auto"
+
 # -- Version matching --------------------------------------------------------
 
 json_url = (

docs/conf.py

@@ -18,3 +18,4 @@ See our `publications <https://www.simdec.fi/publications>`_ and join our
 
    getting-started
    API <api>
+   Tutorials <tutorials>