Merge branch 'ci/pages' into 'master'

CI: Use gitlab pages

See merge request fsl/fsleyes/props!40

.ci/build_doc.sh

 #!/bin/bash
 
+set -e
+
 pip install -r requirements-dev.txt
 python setup.py doc
-mv doc/html doc/"$CI_COMMIT_REF_NAME"
+mkdir -p public
+mv doc/html/* public/

.ci/deploy_doc.sh

-#!/bin/bash
-
-rsync -rv doc/"$CI_COMMIT_REF_NAME" "docdeploy:"

.gitlab-ci.yml

@@ -9,12 +9,12 @@
 #
 #    2. style:  Check coding style
 #
-#    3. doc:    Building API documentation
+#    3. doc:    Building and uploading API documentation using GitLab
+#               Pages.
 #
 #    4. build:  Building source and wheel distributions.
 #
-#    5. deploy: Uploading the build outputs to pypi, and the documentation
-#               to a hosting server.
+#    5. deploy: Uploading the build outputs to pypi.
 #
 # Custom docker images are used for several jobs - these images are
 # available at:
@@ -24,13 +24,10 @@
 # The test and style stages are executed on all branches of upstream and
 # fork repositories.
 #
-# The doc stage, and the deploy-doc job, is executed on all branches of the
-# upstream repository.
+# The doc stage is executed on release branches of the upstream repository.
 #
-# The build stage, and the remaining jobs in the  deploy stage, are only
-# executed on the upstream repository, and only for release tags.
-#
-# The deploy stages are manually instantiated.
+# The build and deploy stages are executed on tags on the upstream
+# repository, and the deploy stages must be manually instantiated.
 ###########################################################################
 
 
@@ -55,14 +52,8 @@ stages:
 #   - SSH_PRIVATE_KEY_GIT            - private key for git login to remote host
 #                                      (UPSTREAM_URL)
 #
-#   - SSH_PRIVATE_KEY_DOC_DEPLOY     - private key for rsyncing documentation
-#                                      to remote host (DOC_HOST)
-
 #   - SSH_SERVER_HOSTKEYS            - List of trusted SSH hosts
 #
-#   - DOC_HOST:                      - Username@host to upload documentation to
-#                                      (e.g. "paulmc@jalapeno.fmrib.ox.ac.uk")
-#
 #   - TWINE_USERNAME:                - Username to use when uploading to pypi
 #
 #   - TWINE_PASSWORD:                - Password to use when uploading to pypi
@@ -92,6 +83,11 @@ variables:
     - master@fsl/fsleyes/props
 
 
+.only_release_branches: &only_release_branches
+  only:
+    - /^v.+$/@fsl/fsleyes/props
+
+
 .only_releases: &only_releases
   only:
     - tags@fsl/fsleyes/props
@@ -131,11 +127,6 @@ variables:
     - bash ./.ci/test_template.sh
 
 
-test:3.6:
-  stage: test
-  image: pauldmccarthy/fsleyes-py36-wxpy4-gtk3
-  <<: *test_template
-
 test:3.7:
   stage: test
   image: pauldmccarthy/fsleyes-py37-wxpy4-gtk3
@@ -146,9 +137,16 @@ test:3.8:
   image: pauldmccarthy/fsleyes-py38-wxpy4-gtk3
   <<: *test_template
 
+
+test:3.9:
+  stage: test
+  image: pauldmccarthy/fsleyes-py39-wxpy4-gtk3
+  <<: *test_template
+
+
 test:build-pypi-dist:
   stage: test
-  image: pauldmccarthy/fsleyes-py36-wxpy4-gtk3
+  image: pauldmccarthy/fsleyes-py38-wxpy4-gtk3
   <<: *except_releases
 
   tags:
@@ -165,7 +163,7 @@ test:build-pypi-dist:
 
 style:
   stage: style
-  image: pauldmccarthy/fsleyes-py36-wxpy4-gtk3
+  image: pauldmccarthy/fsleyes-py38-wxpy4-gtk3
   <<: *test_template
   variables:
     TEST_STYLE:  "true"
@@ -175,22 +173,20 @@ style:
 # Doc stage
 ###########
 
-build-doc:
-  <<: *only_upstream
+pages:
+  <<: *only_release_branches
 
   tags:
    - docker
 
   stage: doc
-  image: python:3.6
+  image: python:3.8
 
   script:
     - bash ./.ci/build_doc.sh
-
   artifacts:
-    expire_in: 1 day
     paths:
-      - doc/$CI_COMMIT_REF_NAME
+      - public
 
 
 #############
@@ -222,23 +218,6 @@ build-pypi-dist:
 ##############
 
 
-deploy-doc:
-  <<: *only_upstream
-  <<: *setup_ssh
-  stage: deploy
-  when:  manual
-  image: python:3.6
-
-  tags:
-    - docker
-
-  dependencies:
-    - build-doc
-
-  script:
-    - bash ./.ci/deploy_doc.sh
-
-
 deploy-pypi:
   <<: *only_releases
   <<: *setup_ssh

CHANGELOG.rst

@@ -2,6 +2,19 @@ This document contains the ``fsleyes-props`` release history in reverse
 chronological order.
 
 
+1.7.1 (Tuesday March 9th 2021)
+------------------------------
+
+
+Changed
+^^^^^^^
+
+
+* The ``fsleyes-props`` API documentation is now hosted at
+  https://open.win.ox.ac.uk/pages/fsl/fsleyes/props/
+* ``fsleyes-props`` is now tested against Python 3.7, 3.8, and 3.9.
+
+
 1.7.0 (Tuesday May 26th 2020)
 -----------------------------
 

setup.py

@@ -96,9 +96,9 @@ setup(
         'Development Status :: 3 - Alpha',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
         'Topic :: Software Development :: Libraries :: Python Modules'],
 
     packages=packages,