Merge pull request #1 from arnauqb/docs

new docs
arnauqb · May 12, 2023 · 97936ae · 97936ae
2 parents ebc5846 + 833347e
commit 97936ae
Show file tree

Hide file tree

Showing 16 changed files with 1,034 additions and 334 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,18 +41,3 @@ jobs:
       with:
         token: ${{secrets.CODECOV_TOKEN}}
         verbose: true
-
-    - name: Install docs dependencies
-      run: |
-        pip install sphinx furo
-    - name: Sphinx build
-      run: |
-        sphinx-build docs _build
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-      with:
-        publish_branch: gh-pages
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: _build/
-        force_orphan: true
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,41 @@
+name: Build docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: [ 3.9 ]
+        os: [ ubuntu-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .
+          python -m pip install -r docs/requirements.txt
+
+      - name: Build docs
+        run: |
+          mkdocs build
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: site
+          force_orphan: true
diff --git a/docs/_static/logo_small.svg b/docs/_static/logo_small.svg
diff --git a/docs/_static/mathjax.js b/docs/_static/mathjax.js
@@ -0,0 +1,16 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => { 
+  MathJax.typesetPromise()
+})
diff --git a/docs/_templates/autosummary/module.rst b/docs/_templates/autosummary/module.rst
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/infer.md b/docs/api/infer.md
@@ -0,0 +1,3 @@
+# Infer
+
+:::birds.infer
diff --git a/docs/birds.models.rst b/docs/birds.models.rst
diff --git a/docs/birds.rst b/docs/birds.rst
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+# BIRDS documentation
diff --git a/docs/index.rst b/docs/index.rst