Merge branch 'sphinx_during_docker_build' into 'master'

Sphinx during docker build

See merge request !1127

.gitlab-ci.yml

@@ -68,7 +68,7 @@ docs:
   script:
     - echo "Building current docs"
     - env -u GITLAB_CI pipenv run make doctest
-    - env -u GITLAB_CI pipenv run sphinx-build -M html "." "_build" -W -j $(nproc)
+    - env -u GITLAB_CI pipenv run sphinx-build -W . _build
     - echo "Checking if there are changes"
     - pipenv run ./generate-apidocs.sh
     - git diff --exit-code

Dockerfile

@@ -65,6 +65,9 @@ COPY website /usr/src/app/website/
 # Copy files for Sphinx documentation
 COPY README.md /usr/src/app/
 COPY docs /usr/src/app/docs
+RUN sphinx-build -c /usr/src/app/docs/ /usr/src/app/docs/ /usr/src/app/docs/_build && \
+    tar --create --xz --file=/usr/src/app/docs.tar.xz --directory=/usr/src/app/docs/_build/ . && \
+    rm --recursive /usr/src/app/docs/
 
 # Cache docs between builds if not mounting to FS
 VOLUME /concrexit/docs

docs/requirements.txt

 recommonmark
-sphinx==1.7.6
+sphinx==1.8.3

resources/entrypoint_production.sh

@@ -2,17 +2,15 @@
 
 set -e
 
->&2 echo "Creating Sphinx documentation"
-sphinx-build -b html /usr/src/app/docs/ /concrexit/docs/
+tar --extract --xz --file=/usr/src/app/docs.tar.xz --directory=/concrexit/docs/
+chown -R www-data:www-data /concrexit/
 
-until psql -h "$DJANGO_POSTGRES_HOST" -U "postgres" -c '\l' $POSTGRES_DB; do
+until psql -h "$DJANGO_POSTGRES_HOST" -U "postgres" -c '\l' "$POSTGRES_DB"; do
     >&2 echo "PostgreSQL is unavailable: Sleeping"
     sleep 5
 done
 >&2 echo "PostgreSQL is up"
 
-chown -R www-data:www-data /concrexit/
-
 cd /usr/src/app/website/
 >&2 echo "Running site with uwsgi"
 uwsgi --chdir /usr/src/app/website \

website/members/services.py

@@ -169,7 +169,7 @@ def execute_data_minimisation(dry_run=False):
     at least 31 days ago
 
     :param dry_run: does not really remove data if True
-    :return list of processed members
+    :return: list of processed members
     """
     members = (Member.objects
                .filter(Q(membership__until__isnull=False) |

website/newsletters/views.py

@@ -74,7 +74,7 @@ def admin_send(request, pk):
     :param request: the request object
     :param pk: the newsletter's primary key
     :return: 302 RedirectResponse if POST else 200 with the
-    confirmation page HTML
+             confirmation page HTML
     """
     newsletter = get_object_or_404(Newsletter, pk=pk)