From 2bb6230b31708d88d80636ebcc0fad13b2c02ba5 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Tue, 29 Nov 2022 11:14:11 +1300 Subject: [PATCH 1/9] Require python 3.8 --- .github/workflows/test-suite.yaml | 2 +- setup.cfg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml index 2b188841..149f14f2 100644 --- a/.github/workflows/test-suite.yaml +++ b/.github/workflows/test-suite.yaml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - python-version: [3.6, 3.7, 3.8, 3.9] + python-version: [3.8, 3.9] steps: - name: Checkout diff --git a/setup.cfg b/setup.cfg index 74cc48d1..9ad24fc7 100644 --- a/setup.cfg +++ b/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 From fe0849e31d55651d9c6f3da6c19aa254489b6d20 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Tue, 29 Nov 2022 11:16:01 +1300 Subject: [PATCH 2/9] Limit to python3.9, as 3.11 breaks a few things --- .github/workflows/documentation.yaml | 2 +- .github/workflows/publish-to-pypi.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml index 58b3c121..17486c37 100644 --- a/.github/workflows/documentation.yaml +++ b/.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: | diff --git a/.github/workflows/publish-to-pypi.yml b/.github/workflows/publish-to-pypi.yml index f8ea8856..7d203648 100644 --- a/.github/workflows/publish-to-pypi.yml +++ b/.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: | From af34cfd5109d9876f4a0ceedf4a0142f407c9a9e Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Mon, 21 Nov 2022 10:41:25 +1300 Subject: [PATCH 3/9] Update docs so that alt tag is required --- docs/source/processors/image-inline.rst | 3 ++- docs/source/processors/image.rst | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/source/processors/image-inline.rst b/docs/source/processors/image-inline.rst index aa75678b..e6279fb6 100644 --- a/docs/source/processors/image-inline.rst +++ b/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. diff --git a/docs/source/processors/image.rst b/docs/source/processors/image.rst index ef7d41b0..df437322 100644 --- a/docs/source/processors/image.rst +++ b/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="http://placehold.it/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://placehold.it/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. From 9bab1695ebae73223b755b7e85ddbf60293e6243 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Mon, 21 Nov 2022 10:51:31 +1300 Subject: [PATCH 4/9] Update version of sphinx to work with python 3.10 --- requirements-dev.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index 437afe46..dde4500a 100644 --- a/requirements-dev.txt +++ b/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 From bba896d9562d308953dc88c53b297d5d21d608e5 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Mon, 21 Nov 2022 10:51:51 +1300 Subject: [PATCH 5/9] Fix broken placeholder links --- docs/source/processors/image.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/processors/image.rst b/docs/source/processors/image.rst index df437322..84af2ac2 100644 --- a/docs/source/processors/image.rst +++ b/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" alt="placeholder 350x150"} + {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" alt="placeholder 350x150"} + {image file-path="http://via.placeholder.com/350x150" caption="false" alt="placeholder 350x150"} Required Tag Parameters From d4e5f824b3f06d557d2b0309f0146f33d15cdd2f Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Thu, 1 Dec 2022 10:25:31 +1300 Subject: [PATCH 6/9] Add python 3.10 and 3.11 to test matrix --- .github/workflows/test-suite.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml index 149f14f2..f76f1dd8 100644 --- a/.github/workflows/test-suite.yaml +++ b/.github/workflows/test-suite.yaml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - python-version: [3.8, 3.9] + python-version: [3.8, 3.9, 3.10, 3.11] steps: - name: Checkout From 0690206d9bb6c2fba5867857a46c363c5ab32f68 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Thu, 1 Dec 2022 10:30:37 +1300 Subject: [PATCH 7/9] Add quotes to 3.10 --- .github/workflows/test-suite.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test-suite.yaml b/.github/workflows/test-suite.yaml index f76f1dd8..12285142 100644 --- a/.github/workflows/test-suite.yaml +++ b/.github/workflows/test-suite.yaml @@ -7,7 +7,8 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - python-version: [3.8, 3.9, 3.10, 3.11] + # Quotes are neccesary otherwise it tries to get Python 3.1 + python-version: [3.8, 3.9, '3.10', 3.11] steps: - name: Checkout From 125e053e426bafadfacc8acf23f71072a90027f7 Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Thu, 1 Dec 2022 10:33:48 +1300 Subject: [PATCH 8/9] Update sphinx to work with python 3.10 --- requirements-dev.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index 437afe46..dde4500a 100644 --- a/requirements-dev.txt +++ b/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 From 96a0132301baa93917768d540b685a787ff9a04a Mon Sep 17 00:00:00 2001 From: Philip Dolbel Date: Fri, 16 Dec 2022 09:50:44 +1300 Subject: [PATCH 9/9] Update version and changelog --- docs/source/changelog.rst | 8 ++++++++ verto/__init__.py | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 2f208993..f735ea06 100644 --- a/docs/source/changelog.rst +++ b/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 ======================================= diff --git a/verto/__init__.py b/verto/__init__.py index d1076386..abd933ef 100644 --- a/verto/__init__.py +++ b/verto/__init__.py @@ -1,4 +1,4 @@ # flake8: noqa from .Verto import Verto -__version__ = '1.0.1' +__version__ = '1.1.0'