Moved docs CI tests to separate action (#34)

.github/workflows/test_docs.yml

@@ -0,0 +1,46 @@
+# Run docs tox tests on Ubuntu Docker images using GIFT PPA
+name: test_docs
+on:
+  pull_request:
+    branches:
+    - main
+  push:
+    branches:
+    - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+        - python-version: '3.8'
+          toxenv: 'docs'
+    container:
+      image: ubuntu:20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up container
+      env:
+        DEBIAN_FRONTEND: noninteractive
+      run: |
+        apt-get update -q
+        apt-get install -y libterm-readline-gnu-perl locales software-properties-common
+        locale-gen en_US.UTF-8
+        ln -f -s /usr/share/zoneinfo/UTC /etc/localtime
+    - name: Install dependencies
+      env:
+        DEBIAN_FRONTEND: noninteractive
+      run: |
+        add-apt-repository -y universe
+        add-apt-repository -y ppa:deadsnakes/ppa
+        add-apt-repository -y ppa:gift/dev
+        apt-get update -q
+        apt-get install -y build-essential git libffi-dev python${{ matrix.python-version }} python${{ matrix.python-version }}-dev python${{ matrix.python-version }}-venv libbde-python3 libcreg-python3 libewf-python3 libfsapfs-python3 libfsext-python3 libfshfs-python3 libfsntfs-python3 libfsxfs-python3 libfvde-python3 libfwnt-python3 libluksde-python3 libmodi-python3 libphdi-python3 libqcow-python3 libregf-python3 libsigscan-python3 libsmdev-python3 libsmraw-python3 libvhdi-python3 libvmdk-python3 libvsgpt-python3 libvshadow-python3 libvslvm-python3 python3-artifacts python3-cffi-backend python3-cryptography python3-dfdatetime python3-dfvfs python3-dfwinreg python3-distutils python3-dtfabric python3-idna python3-mock python3-pbr python3-pip python3-pytsk3 python3-pyxattr python3-setuptools python3-six python3-yaml
+    - name: Install tox
+      run: |
+        python3 -m pip install tox
+    - name: Run tests
+      env:
+        LANG: en_US.UTF-8
+      run: |
+        tox -e${{ matrix.toxenv }}

.github/workflows/test_tox.yml

@@ -25,8 +25,6 @@ jobs:
           toxenv: 'py310'
         - python-version: '3.8'
           toxenv: 'pylint'
-        - python-version: '3.8'
-          toxenv: 'docs'
     container:
       image: ubuntu:20.04
     steps:

ACKNOWLEDGEMENTS

@@ -1,6 +1,6 @@
 Acknowledgements: dfimagetools
 
-Copyright 2021 The dfImageTools Project Authors.
+Copyright 2021 The dfImageTools authors.
 Please see the AUTHORS file for details on individual authors.
 
 dfImageTools originates from the Plaso project [https://github.com/log2timeline/plaso].

docs/sources/user/Installation-instructions.md

@@ -63,5 +63,5 @@ To install the release versions of the dependencies run:
 ```
 set PYTHONPATH=.
 
-C:\Python38\python.exe tools\update.py --preset dfimagetools
+C:\Python3\python.exe tools\update.py --preset dfimagetools
 ```

setup.cfg

@@ -12,7 +12,9 @@ manifest = MANIFEST.test_data
 [bdist_rpm]
 release = 1
 packager = Log2Timeline maintainers <[email protected]>
-doc_files = LICENSE
+doc_files = ACKNOWLEDGEMENTS
+            AUTHORS
+            LICENSE
             README
 build_requires = python3-setuptools
 requires = libbde-python3 >= 20220121

setup.py

@@ -229,7 +229,7 @@ def parse_requirements_from_file(path):
     scripts=glob.glob(os.path.join('tools', '[a-z]*.py')),
     data_files=[
         ('share/doc/dfimagetools', [
-            'LICENSE', 'README']),
+            'ACKNOWLEDGEMENTS', 'AUTHORS', 'LICENSE', 'README']),
     ],
     install_requires=parse_requirements_from_file('requirements.txt'),
     tests_require=parse_requirements_from_file('test_requirements.txt'),