Adds action for the documentation (#18)

* Adds action for the documentation * update * doc * rename * index * remove one line * Update requirements-dev.txt * Update requirements-dev.txt * Update requirements-dev.txt --------- Co-authored-by: xavier dupré <xavier.dupre@gmail.com>
sdpython · Apr 23, 2023 · 237ba77 · 237ba77
1 parent 33f366e
commit 237ba77
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 35 deletions.
diff --git a/.github/workflows/cmakelint.yml b/.github/workflows/cmakelint.yml
@@ -1,4 +1,4 @@
-name: Run cmake-format linter
+name: Cmake Format Checker
 
 on: [push]
 

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,35 @@
+name: Documentation
+
+on: [push, pull_request]
+
+jobs:
+  build_wheels:
+    name: Build documentation on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # Used to host cibuildwheel
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install requirements
+        run: python -m pip install -r requirements.txt
+
+      - name: Install requirements-dev.txt
+        run: python -m pip install -r requirements-dev.txt
+
+      - name: Install
+        run: python -m pip install -e .
+
+      - name: Documentation
+        run: python -m sphinx ./_doc ./dist/html
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: ./dist/html/**
diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml
diff --git a/_doc/examples/plot_bench_cpu_vector_sum_parallel.py b/_doc/examples/plot_bench_cpu_vector_sum_parallel.py
@@ -1,5 +1,5 @@
 """
-.. _l-example-bench-cpu-vector-sum:
+.. _l-example-bench-cpu-vector-sum-parallel:
 
 Measuring CPU performance with a parallelized vector sum
 ========================================================

diff --git a/_doc/index.rst b/_doc/index.rst
@@ -54,7 +54,6 @@ see also `code coverage <cov/index.html>`_.
     from onnx_extended.ext_test_case import measure_time
     from onnx_extended.reference import CReferenceEvaluator
 
-
     X = make_tensor_value_info("X", TensorProto.FLOAT, [None, None, None, None])
     Y = make_tensor_value_info("Y", TensorProto.FLOAT, [None, None, None, None])
     B = make_tensor_value_info("B", TensorProto.FLOAT, [None, None, None, None])

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,3 +1,4 @@
+autopep8
 black
 clang-format
 cmakelang
@@ -14,7 +15,7 @@ onnxmltools
 onnxruntime; python_version < '3.11'
 pandas
 psutil
-pyquickhelper
+pyquickhelper>=1.12.3821
 pytest
 pytest-cov
 ruff