From 4b22bd0f7d9f1d16cb00a22975a535f7a2fec54d Mon Sep 17 00:00:00 2001 From: Jean-Christophe Hugly Date: Mon, 22 Jul 2024 12:15:24 +0200 Subject: [PATCH] Add a WIP section, so the doc build doesn't have to fail for new design docs. It is not possible to build without error in the presence of a document that is not in the index. In order for CS not to fail for PRs that include a new, not-yet-approved doc, adding an index section where they can be safely linked. --- doc/dev/design/index.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/dev/design/index.rst b/doc/dev/design/index.rst index 6a28e80404..6acd4bdea9 100644 --- a/doc/dev/design/index.rst +++ b/doc/dev/design/index.rst @@ -8,7 +8,8 @@ See section :ref:`change-proposal-process` for the overview on the overall contribution process. - **Creation**: - Design documents are created from the template :file-ref:`doc/dev/design/TEMPLATE.rst`. + Design documents are created from the template :file-ref:`doc/dev/design/TEMPLATE.rst`. While the design is still being discussed, it is linked in the WIP + section :ref:`design-docs-wip` Once discussion on a change proposal converges and a design document is approved, it is inserted to section :ref:`design-docs-active`. @@ -30,6 +31,13 @@ contribution process. a useful reference for the current system, it moves to section :ref:`design-docs-outdated`. +.. _design-docs-wip: + +WIP +=== +.. toctree:: + :maxdepth: 1 + .. _design-docs-active: Active