From 7fc2c662085ef5c2872b8c5b316b293e7305c540 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Brul=C3=A9?= <raphael.brule@savoirfairelinux.com> Date: Wed, 1 Mar 2023 14:30:23 -0500 Subject: [PATCH] contribute: add note regarding building problem Following the instructions for building the documention errors out. This commit adds a note to aknowledge the issue and a link to the relevant GitLab issue. Change-Id: I030a10d8c541feafa5c93b569e2e285b6fb6c5ee --- contribute.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/contribute.rst b/contribute.rst index 5a3f1504..a0db7490 100644 --- a/contribute.rst +++ b/contribute.rst @@ -124,6 +124,11 @@ From the base of the repository, run: You should now be able to view the documentation in your web browser. The homepage is at ``_build/html/index.html``. +.. note:: This documentation does not currently build with the latest + version of sphinx. Please see `this issue on GitLab + <https://git.jami.net/savoirfairelinux/jami-docs/-/issues/15>`_ + for a workaround and updates regarding this problem. + To automatically build the documentation and refresh your web browser whenever you save changes, run: -- GitLab