From eecfa0cc452fddf38adf395aa71e982893960058 Mon Sep 17 00:00:00 2001 From: steph237 Date: Sun, 23 Oct 2022 17:49:16 +0100 Subject: [PATCH] update: added note in contribution section for Tox error when building --- docs/contributing.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 64e61abacb..0e8f9c0aa7 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -245,6 +245,11 @@ The documentation can be built locally by running:: $ tox -e docs +.. note:: + In a scenario where the build fails, change the + basepython = python3.8 to the latest version of python( for Ubuntu 22.04 ). + + The resulting built documentation will be available in the ``.tox/docs/tmp/html`` folder. Development best practices, policies and procedures