Browse Source

Adding some docs

pull/536/head
Lucas Cimon 5 months ago
parent
commit
7ac8722969
No known key found for this signature in database
GPG Key ID: 8DA831E717571EE
  1. 4
      .github/workflows/python-tests.yml
  2. 3
      src/sigal/plugins/nonmedia_files.py
  3. 2
      tox.ini

4
.github/workflows/python-tests.yml

@ -26,10 +26,10 @@ jobs:
uses: actions/setup-python@v6 uses: actions/setup-python@v6
with: with:
python-version: ${{ matrix.python-version }} python-version: ${{ matrix.python-version }}
- name: Install FFmpeg - name: Install FFmpeg & Poppler
run: | run: |
sudo apt update sudo apt update
sudo apt install ffmpeg sudo apt install ffmpeg poppler-utils
ffmpeg -version ffmpeg -version
- name: Install Tox - name: Install Tox
run: python -m pip install tox tox-gh-actions coverage run: python -m pip install tox tox-gh-actions coverage

3
src/sigal/plugins/nonmedia_files.py

@ -4,6 +4,9 @@ This plugin will copy the files into the build tree and generate generic
thumbnails for the files. In-browser previews will likely fail, and thumbnails for the files. In-browser previews will likely fail, and
it is up to the theme to provide correct support for downloads. it is up to the theme to provide correct support for downloads.
If the `pdf2image <https://pypi.org/project/pdf2image/>`_ optional dependency is installed,
it will be used to generate thumbnails for PDF files.
Settings available as dictionary in ``nonmedia_files_options``: Settings available as dictionary in ``nonmedia_files_options``:
- ``ext_as_thumb``: Enable simple thumbnail showing ext. Default to ``True`` - ``ext_as_thumb``: Enable simple thumbnail showing ext. Default to ``True``

2
tox.ini

@ -17,6 +17,8 @@ deps =
pillow10: Pillow==10.0.1 pillow10: Pillow==10.0.1
pillow11: Pillow==11.0.0 pillow11: Pillow==11.0.0
pillow12: Pillow==12.0.0 pillow12: Pillow==12.0.0
# We only install the pdf2image package in one environement:
pillow-latest: pdf2image
extras = extras =
all all
tests tests

Loading…
Cancel
Save