From 4911fba4af788bbed0fffedb2c72c95a178a001d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Mon, 21 Oct 2019 15:15:32 +0300 Subject: [PATCH 1/2] Docs: Fix various build warnings: - /docs/configuration.rst:157: WARNING: Inline emphasis start-string without end-string. - /docs/configuration.rst:159: WARNING: Inline emphasis start-string without end-string. - /docs/configuration.rst:159: WARNING: Inline emphasis start-string without end-string. - /docs/configuration.rst:159: WARNING: Inline emphasis start-string without end-string. - /docs/rpi_build.rst: WARNING: document isn't included in any toctree --- docs/configuration.rst | 6 +++--- docs/index.rst | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index a536c700..46429b61 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -154,11 +154,11 @@ optional port number. Those variables are: - ``HOST_REDIS``: the container that is running the redis daemon (default: ``redis``) - ``HOST_WEBMAIL``: the container that is running the webmail (default: ``webmail``) -The startup scripts will resolve HOST_* to their IP addresses and store the result in *_ADDRESS for further use. +The startup scripts will resolve ``HOST_*`` to their IP addresses and store the result in ``*_ADDRESS`` for further use. -Alternatively, *_ADDRESS can directly be set. In this case, the values of *_ADDRESS is kept and not +Alternatively, ``*_ADDRESS`` can directly be set. In this case, the values of ``*_ADDRESS`` is kept and not resolved. This can be used to rely on DNS based service discovery with changing services IP addresses. -When using *_ADDRESS, the hostnames must be full-qualified hostnames. Otherwise nginx will not be able to +When using ``*_ADDRESS``, the hostnames must be full-qualified hostnames. Otherwise nginx will not be able to resolve the hostnames. diff --git a/docs/index.rst b/docs/index.rst index 476cf7fa..74dabd36 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -60,6 +60,7 @@ the version of Mailu that you are running. dns reverse database + rpi_build .. toctree:: :maxdepth: 2 From d94c8bce53d77e4311d8fdb3f97ccc572b982670 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20M=C3=B6hlmann?= Date: Mon, 21 Oct 2019 15:18:53 +0300 Subject: [PATCH 2/2] Docs: treat warnings as errors --- docs/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index b3257a80..70c9c3c4 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -14,7 +14,7 @@ COPY ./nginx.conf /etc/nginx/conf.d/default.conf COPY . /docs RUN mkdir -p /build/$VERSION \ - && sphinx-build /docs /build/$VERSION + && sphinx-build -W /docs /build/$VERSION EXPOSE 80/tcp