From 981fbe3873d7c1c121499bf83557f6d72425bf69 Mon Sep 17 00:00:00 2001
From: Rémi Flamary <remi.flamary@gmail.com>
Date: Fri, 24 Mar 2023 10:13:59 +0100
Subject: [WIP] Build donc in GH Action and report warnings + move contributing
 and code of conduct in documentation (#441)

* use action for doc with wraning visible

* remove space

* remove space again

* test pre commands

* install pot properly

* install compiler...

* try composite action

* remoe warning in sliced exmaple

* pep8

* move contributing and code of conduct

* cleanup

* underline too short

* update quickstart

* replace version selector by static list to avoid jsQuery bug
---
 .github/CONTRIBUTING.md         |  1 -
 .github/workflows/build_doc.yml | 44 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/build_doc.yml

(limited to '.github')

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 9bc8e87..168ffb3 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -1,4 +1,3 @@
-
 Contributing to POT
 ===================
 
diff --git a/.github/workflows/build_doc.yml b/.github/workflows/build_doc.yml
new file mode 100644
index 0000000..93bd113
--- /dev/null
+++ b/.github/workflows/build_doc.yml
@@ -0,0 +1,44 @@
+name: Build doc
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - 'master'  
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    # Standard drop-in approach that should work for most people.
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Get Python running
+      run: |
+        python -m pip install --user --upgrade --progress-bar off pip
+        python -m pip install --user --upgrade --progress-bar off -r requirements.txt
+        python -m pip install --user --upgrade --progress-bar off -r docs/requirements.txt
+        python -m pip install --user --upgrade --progress-bar off ipython "https://api.github.com/repos/sphinx-gallery/sphinx-gallery/zipball/master" memory_profiler
+        python -m pip install --user -e .
+    # Look at what we have and fail early if there is some library conflict
+    - name: Check installation
+      run: |
+        which python
+        python -c "import ot"
+    # Build docs
+    - name: Generate HTML docs
+      uses: rickstaa/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+    - uses: actions/upload-artifact@v1
+      with:
+        name: Documentation
+        path: docs/build/html/
\ No newline at end of file
-- 
cgit v1.2.3