readthedoc fixes

.github/workflows/main.yml

@@ -1,38 +1,27 @@
 name: Build
 
-on: [push, pull_request]
+on: push
 
 jobs:
   analyze:
     name: Analyze
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
 
     strategy:
-      fail-fast: false
       matrix:
-        language: [ 'python' ]
+        python-version: ["3.11"]
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+        name: Set up Python ${{ matrix.python-version }}
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.8
-
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
+          python-version: ${{ matrix.python-version }}
       - name: Install prerequisites
         run: |
-          sudo apt-get update && sudo apt-get install libsdl2-mixer-2.0-0 libsdl2-image-2.0-0 libsdl2-2.0-0
+          sudo apt-get update && sudo apt-get install libnotify4 libsdl2-mixer-2.0-0 libsdl2-image-2.0-0 libsdl2-2.0-0
           python -m pip install --upgrade pip
-          pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04 wxPython==4.1.0
+          pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04 wxPython==4.2.1
           pip install wheel coveralls
           pip install -r requirements.txt
 
@@ -49,7 +38,7 @@ jobs:
         uses: AndreMiras/coveralls-python-action@develop
 
       - name: Upload test results
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: coverage-report
           path: coverage/index.html
@@ -62,15 +51,14 @@ jobs:
   release:
     name: Release to PyPI
     needs: [ analyze ]
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+        name: Set up Python 3.11
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.11
       - name: Install pypa/build
         run: |
           python -m pip install build --user
@@ -79,7 +67,7 @@ jobs:
           git clean -dfx
           python -m build --sdist --wheel --outdir dist/ .
       - name: Upload wheel
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: wheel
           path: dist/*.whl

.gitignore

@@ -1,8 +1,9 @@
-/error_log.txt
-/settings.json
-/.coverage
-/dist/
-/build/
-/asn1editor.egg-info/
-/test.json
-/docs/_build/
+error_log.txt
+settings.json
+.coverage
+dist/
+build/
+asn1editor.egg-info/
+test.json
+docs/_build/
+.idea/*

.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  apt_packages:
+    - libnotify4
+    - libsdl2-mixer-2.0-0
+    - libsdl2-image-2.0-0
+    - libsdl2-2.0-0
+  jobs:
+    post_create_environment:
+      - python -m pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04 wxPython==4.2.1
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -1,6 +1,7 @@
 ![Build](https://github.com/Futsch1/asn1editor/workflows/Build/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/Futsch1/asn1editor/badge.svg?branch=master)](https://coveralls.io/github/Futsch1/asn1editor?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/b2492b88948ace2e8a14/maintainability)](https://codeclimate.com/github/Futsch1/asn1editor/maintainability)
+[![Documentation Status](https://readthedocs.org/projects/asn1editor/badge/?version=latest)](https://asn1editor.readthedocs.io/en/latest/?badge=latest)
 # asn1editor
 Python based ASN.1 editor
 

docs/requirements.txt

@@ -0,0 +1 @@
+asn1tools