Merge pull request #136 from portugueslab/deploy_fix

Documentations deployment fix

.github/workflows/doc_deploy.yml

@@ -1,9 +1,9 @@
-name: 🚀 page_deploy
+name: 🚀 Deploy Documentation
 
 on:
   push:
     branches:
-      - main
+      - master
   pull_request:
     types:
       - assigned

.github/workflows/main.yml

@@ -1,6 +1,25 @@
-name: tests
+name: 🤖 Lint - Tests - Deploy
 
-on: push
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - assigned
+      - unassigned
+      - labeled
+      - unlabeled
+      - opened
+      - edited
+      - reopened
+      - synchronize
+      - ready_for_review
+      - locked
+      - unlocked
+      - review_requested
+      - review_request_
+  workflow_dispatch: 
 
 jobs:
   lint:

Makefile

@@ -3,7 +3,6 @@
 docs:
 	rm -rf docs/_build/html
 	find docs/api ! -name 'index.rst' -type f -exec rm -f {} +
-	pip install -qr docs/requirements.txt
 	pip install -r requirements.txt
 	pip install -r requirements_dev.txt
 	pip install -e .

docs/_toc.yml

@@ -1,22 +1,19 @@
-- file: index
-
-- part: Overview
+format: jb-book
+root: index
+parts:
+- caption: Overview
   chapters:
-    - file: timeline
-
-- part: Configuration
+  - file: timeline
+- caption: Configuration
   chapters:
-    - file: configuration/installation
-    - file: configuration/configuration
-
-- part: Development
+  - file: configuration/installation
+  - file: configuration/configuration
+- caption: Development
   chapters:
-    - file: development/code_organization
-
-- part: Hardware
+  - file: development/code_organization
+- caption: Hardware
   chapters:
-    - file: hardware/hardware
-
-- part: Api
+  - file: hardware/hardware
+- caption: Api
   chapters:
-    - file: api/index
+  - file: api/index

requirements_dev.txt

@@ -7,3 +7,9 @@ pre-commit
 black==22.3.0
 flake8
 isort
+
+jupyter-book
+jupytext
+sphinx_autodoc_typehints
+furo
+recommonmark