Add changelogs to the documentation (#8)

* Add changelogs to the documentation

* pr

Author: xadupre

.github/workflows/codeql.yml

@@ -0,0 +1,61 @@
+name: "Code Scanning - Action"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  schedule:
+    #        ┌───────────── minute (0 - 59)
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        *  * * * *
+    - cron: '30 1 * * 0'
+
+jobs:
+  CodeQL-Build:
+    # CodeQL runs on ubuntu-latest, windows-latest, and macos-latest
+    runs-on: ubuntu-latest
+
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        # Override language selection by uncommenting this and choosing your languages
+        # with:
+        #   languages: go, javascript, csharp, python, cpp, java, ruby
+
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below).
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following
+      #    three lines and modify them (or add more) to build your code if your
+      #    project uses a compiled language
+
+      #- run: |
+      #     make bootstrap
+      #     make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/documentation.yml

@@ -29,6 +29,12 @@ jobs:
       - name: Install
         run: python -m pip install -e .
 
+      - name: Copy files
+        run: |
+          cp LICENSE* ./_doc
+          cp CHANGELOGS* ./_doc
+
+
       - name: Documentation
         run: python -m sphinx ./_doc ./dist/html -n -w doc.txt
 

_doc/conf.py

@@ -15,6 +15,7 @@
     "sphinx.ext.viewcode",
     "sphinx_gallery.gen_gallery",
     "matplotlib.sphinxext.plot_directive",
+    "sphinx_issues",
     "sphinx_runpython.blocdefs.sphinx_blocref_extension",
     "sphinx_runpython.blocdefs.sphinx_exref_extension",
     "sphinx_runpython.blocdefs.sphinx_mathdef_extension",

_doc/index.rst

@@ -30,6 +30,8 @@ sphinx-runpython: (Numpy) Array API for ONNX
 
     api/index
     auto_examples/index
+    CHANGELOGS
+    license
 
 Sources available on
 `github/sphinx-runpython <https://github.com/sdpython/sphinx-runpython>`_,

_doc/license.rst

@@ -0,0 +1,5 @@
+License
+=======
+
+.. literalinclude:: LICENSE
+   :language: none

requirements-dev.txt

@@ -14,6 +14,7 @@ pytest-cov
 ruff
 sphinx
 sphinx-gallery
+sphinx-issues
 rstcheck[sphinx,toml]
 tomli
 tqdm