Merge branch 'mirkobunse-devel' into devel

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
   push:
     branches:
-      - main
+      - master
       - devel
 
 jobs:
@@ -31,3 +31,34 @@ jobs:
         python -m pip install -e .[bayes,composable,tests]
     - name: Test with unittest
       run: python -m unittest
+
+  # build and push documentation to gh-pages (only if pushed to the master branch)
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/master'
+    steps:
+    - uses: actions/checkout@v1
+    - name: Build documentation
+      uses: ammaraskar/sphinx-action@master
+      with:
+        pre-build-command: |
+          apt-get --allow-releaseinfo-change update -y && apt-get install -y git && git --version
+          python -m pip install --upgrade pip setuptools wheel "jax[cpu]"
+          python -m pip install -e .[composable,neural,docs]
+        docs-folder: "docs/"
+    - name: Publish documentation
+      run: |
+        git clone ${{ github.server_url }}/${{ github.repository }}.git --branch gh-pages --single-branch __gh-pages/
+        cp -r docs/build/html/* __gh-pages/
+        cd __gh-pages/
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add .
+        git commit -am "Documentation based on ${{ github.sha }}" || true
+    - name: Push changes
+      uses: ad-m/github-push-action@master
+      with:
+        branch: gh-pages
+        directory: __gh-pages/
+        github_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -116,4 +116,4 @@ are provided:
 
 ## Acknowledgments:
 
-<img src="SoBigData.png" alt="SoBigData++" width="250"/>
+<img src="docs/source/SoBigData.png" alt="SoBigData++" width="250"/>

docs/.gitignore

@@ -0,0 +1 @@
+build/

docs/Makefile

@@ -14,20 +14,7 @@ help:
 
 .PHONY: help Makefile
 
-# Convert Markdown files to reStructuredText before building HTML
-markdown_to_rst:
-	@echo "Converting Markdown files to reStructuredText"
-	@mkdir -p $(SOURCEDIR)/wiki/wiki_examples/selected_plots
-	@cp $(SOURCEDIR)/wiki_editable/wiki_examples/selected_plots/* $(SOURCEDIR)/wiki/wiki_examples/selected_plots/
-	@find $(SOURCEDIR)/wiki_editable -name '*.md' -exec sh -c 'pandoc -f markdown -t rst "$$1" -o "$(SOURCEDIR)/wiki/$$(basename "$$1" .md).rst"' _ {} \;
-	@echo "Conversion complete."
-
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-html: markdown_to_rst
+%: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-# # Catch-all target: route all unknown targets to Sphinx using the new
-# # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-# %: Makefile
-# 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)