Verified Commit c14aabd7 authored by Huste, Tobias (FWCC) - 111645's avatar Huste, Tobias (FWCC) - 111645
Browse files

use latest Sphinx version for building docs

- require forked version of sphinxcontrib-versioning in CI
- reduce redundancies in .gitlab-ci.yml
- add specific docs test before deployment
parent f5dca585
Pipeline #7657 passed with stages
in 13 minutes and 50 seconds
......@@ -17,14 +17,6 @@
# You should have received a copy of the GNU General Public License
# along with Rodare. If not, see <http://www.gnu.org/licenses/>.
services:
- redis:3-alpine
- postgres:9-alpine
- mysql:5
- name: registry.hzdr.de/rodare/sftp-docker
alias: sftp
command: ["foo:pass:::upload"]
variables:
POSTGRES_USER: postgres
POSTGRES_DB: test
......@@ -106,9 +98,33 @@ before_script:
.pypi: &pypi
REQUIREMENTS: pypi
.services-mysql: &services-mysql
services:
- redis:3-alpine
- mysql:5
- name: registry.hzdr.de/rodare/sftp-docker
alias: sftp
command: ["foo:pass:::upload"]
.services-postgres: &services-postgres
services:
- redis:3-alpine
- postgres:9-alpine
- name: registry.hzdr.de/rodare/sftp-docker
alias: sftp
command: ["foo:pass:::upload"]
.services-sqlite: &services-sqlite
services:
- redis:3-alpine
- name: registry.hzdr.de/rodare/sftp-docker
alias: sftp
command: ["foo:pass:::upload"]
py3.5-min-sqlite:
<<: *python35
<<: *cache-sqlite
<<: *services-sqlite
variables:
<<: *sqlite
<<: *min
......@@ -116,6 +132,7 @@ py3.5-min-sqlite:
py3.5-pypi-sqlite:
<<: *python35
<<: *cache-sqlite
<<: *services-sqlite
variables:
<<: *sqlite
<<: *pypi
......@@ -123,6 +140,7 @@ py3.5-pypi-sqlite:
py3.5-min-postgresql:
<<: *python35
<<: *cache-postgres
<<: *services-postgres
variables:
<<: *postgresql
<<: *min
......@@ -130,6 +148,7 @@ py3.5-min-postgresql:
py3.5-pypi-postgresql:
<<: *python35
<<: *cache-postgres
<<: *services-postgres
variables:
<<: *postgresql
<<: *pypi
......@@ -137,6 +156,7 @@ py3.5-pypi-postgresql:
py3.5-min-mysql:
<<: *python35
<<: *cache-mysql
<<: *services-mysql
variables:
<<: *mysql
<<: *min
......@@ -144,6 +164,7 @@ py3.5-min-mysql:
py3.5-pypi-mysql:
<<: *python35
<<: *cache-mysql
<<: *services-mysql
variables:
<<: *mysql
<<: *pypi
......@@ -151,6 +172,7 @@ py3.5-pypi-mysql:
py3.6-min-sqlite:
<<: *python36
<<: *cache-sqlite
<<: *services-sqlite
variables:
<<: *sqlite
<<: *min
......@@ -158,6 +180,7 @@ py3.6-min-sqlite:
py3.6-pypi-sqlite:
<<: *python36
<<: *cache-sqlite
<<: *services-sqlite
variables:
<<: *sqlite
<<: *pypi
......@@ -165,6 +188,7 @@ py3.6-pypi-sqlite:
py3.6-min-postgresql:
<<: *python36
<<: *cache-postgres
<<: *services-postgres
variables:
<<: *postgresql
<<: *min
......@@ -172,6 +196,7 @@ py3.6-min-postgresql:
py3.6-pypi-postgresql:
<<: *python36
<<: *cache-postgres
<<: *services-postgres
variables:
<<: *postgresql
<<: *pypi
......@@ -179,6 +204,7 @@ py3.6-pypi-postgresql:
py3.6-min-mysql:
<<: *python36
<<: *cache-mysql
<<: *services-mysql
variables:
<<: *mysql
<<: *min
......@@ -186,13 +212,13 @@ py3.6-min-mysql:
py3.6-pypi-mysql:
<<: *python36
<<: *cache-mysql
<<: *services-mysql
variables:
<<: *mysql
<<: *pypi
pages:
stage: deploy
image: python:3.5
.docs: &docs
image: python:3.6
variables:
EXTRAS: docs,sqlite
REQUIREMENTS: pypi
......@@ -201,7 +227,19 @@ pages:
- pip install coveralls requirements-builder
- requirements-builder -e $EXTRAS --level=$REQUIREMENTS setup.py > .ci-$REQUIREMENTS-requirements.txt
- pip install -r .ci-$REQUIREMENTS-requirements.txt
- pip install -U git+https://github.com/leokoppel/sphinxcontrib-versioning.git#egg=sphinxcontrib-versioning
- pip install -e .[$EXTRAS]
test-docs:
stage: test
<<: *docs
script:
# Build tags with pattern v* and master branch
- sphinx-versioning build -T -W v* -w master docs docs/_build/html
pages:
stage: deploy
<<: *docs
script:
- mkdir .public
# Build tags with pattern v* and master branch
......
......@@ -313,7 +313,7 @@ def is_upload_active(user_id, bucket_id):
Args:
user_id(int): User id to check the upload status for.
bucket_id(uuid): The bucket that shall be checked for active jobs.
bucket_id(uuid.UUID): The bucket that shall be checked for active jobs.
Returns:
bool: True, if a background job is active or pending for the bucket
......
......@@ -46,8 +46,7 @@ tests_require = [
extras_require = {
'docs': [
'Sphinx>=1.5.6,<1.7',
'sphinxcontrib-versioning>=2.2.1',
'Sphinx>=1.5.6',
'sphinx_rtd_theme>=0.2.4',
],
'mysql': [
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment