Merge branch 'release/1.1.0'

.github/workflows/documentation.yaml

@@ -13,7 +13,7 @@ jobs:
       - name: Set up Python 3
         uses: actions/setup-python@v2.2.2
         with:
-          python-version: '3.x'
+          python-version: '3.9'
 
       - name: Install dependencies
         run: |

.github/workflows/publish-to-pypi.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up Python 3
         uses: actions/setup-python@v2.2.2
         with:
-          python-version: '3.x'
+          python-version: '3.9'
 
       - name: Install build dependencies
         run: |

.github/workflows/test-suite.yaml

@@ -7,7 +7,8 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        # Quotes are neccesary otherwise it tries to get Python 3.1
+        python-version: [3.8, 3.9, '3.10', 3.11]
 
     steps:
       - name: Checkout

docs/source/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 #######################################
 
+1.1.0
+=======================================
+
+- Update documentation to say that alt tags are required for images.
+- Update old examples in the documentation
+- Update minimum Python version to 3.8, as 3.7 was causing issues with our linter.
+- Update sphinx from 4.0.2 to 4.2.0.
+
 1.0.1
 =======================================
 

docs/source/processors/image-inline.rst

@@ -19,11 +19,12 @@ Required Tag Parameters
 
     - Each file-path provided is added to the ``images`` set in required files stored by Verto. The set of filepaths can be accessed after conversion, see :ref:`accessing_verto_data`.
     - **Note:** If the given link is a relative (a link that doesn't start with ``http:``), the link will be rendered with a Django static command. For example, the link ``images/example.png`` would be rendered as ``{% static 'images/example.png' %}`` This can be overriden, see the override section below.
+
+- ``alt`` - Description text of the image used when an image is not displayed, or can be read when using a screen reader (for those with reading difficulties).
 
 Optional Tag Parameters
 ***************************************
 
-- ``alt`` - Description text of the image used when an image is not displayed, or can be read when using a screen reader (for those with reading difficulties).
 - ``caption`` - Lists the given text as a caption under the image.
 - ``caption-link`` (requires caption parameter) - Converts the caption text into a link to the given caption link URL.
 - ``source`` (optional) - Adds the text 'Source' under the image with a link to the given source URL. Displays after the caption if a caption is given.

docs/source/processors/image.rst

@@ -7,7 +7,7 @@ You can include an image using the following text tag:
 
 .. code-block:: none
 
-    {image file-path="http://placehold.it/350x150" caption="true"}
+    {image file-path="https://via.placeholder.com/350x150" caption="true" alt="placeholder 350x150"}
 
     This is the caption text.
 
@@ -20,7 +20,7 @@ If a caption is not needed, an end tag is not required (see example below).
 
 .. code-block:: none
 
-    {image file-path="http://placehold.it/350x150" caption="false"}
+    {image file-path="http://via.placeholder.com/350x150" caption="false" alt="placeholder 350x150"}
 
 
 Required Tag Parameters
@@ -31,11 +31,11 @@ Required Tag Parameters
     - Each file-path provided is added to the ``images`` set in required files stored by Verto. The set of filepaths can be accessed after conversion, see :ref:`accessing_verto_data`.
     - **Note:** If the given link is a relative (a link that doesn't start with ``http:``), the link will be rendered with a Django static command. For example, the link ``images/example.png`` would be rendered as ``{% static 'images/example.png' %}`` This can be overriden, see the override section below.
 
+- ``alt`` - Description text of the image used when an image is not displayed, or can be read when using a screen reader (for those with reading difficulties).
+
 Optional Tag Parameters
 ***************************************
 
-- ``alt`` - Description text of the image used when an image is not displayed, or can be read when using a screen reader (for those with reading difficulties).
-
 - ``caption`` - Boolean flag to indicate whether the image should display a caption.
 
     - If given as ``true``, the the subtitle is the first block of text with the image block.

requirements-dev.txt

@@ -1,5 +1,5 @@
 setuptools==56.2.0
-sphinx==4.0.2
+sphinx==4.2.0
 sphinx_rtd_theme==0.5.2
 coverage==5.5
 flake8==3.9.2

setup.cfg

@@ -39,7 +39,7 @@ project_urls =
 
 [options]
 packages = find:
-python_requires = >=3.6
+python_requires = >=3.8
 include_package_data = True
 install_requires =
     markdown==2.6.11

verto/__init__.py

@@ -1,4 +1,4 @@
 # flake8: noqa
 from .Verto import Verto
 
-__version__ = '1.0.1'
+__version__ = '1.1.0'