From 9e9aa934801d4c6a3416b490e21588d731d5a02a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Wed, 6 Dec 2023 14:57:52 -0800 Subject: [PATCH] Clarified where to run Make commands for building documentation --- docs/source/contributing/documentation.md | 4 +++- packages/volto/news/5505.documentation | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 packages/volto/news/5505.documentation diff --git a/docs/source/contributing/documentation.md b/docs/source/contributing/documentation.md index c8a4c097f6..a43cc6cc97 100644 --- a/docs/source/contributing/documentation.md +++ b/docs/source/contributing/documentation.md @@ -35,9 +35,11 @@ The {doc}`plone:index` also provides excellent references for writing high quali ### Building and checking the quality of narrative documentation -We use Make commands to run Sphinx to build and check documentation. +You can use Make commands to run Sphinx to build and check documentation. All build and check documentation commands use the file `Makefile`. + In Volto, all documentation commands are prefixed with `docs-`. +You should run these commands from the root of the `volto` repository. To see the all Make commands, use the following command. diff --git a/packages/volto/news/5505.documentation b/packages/volto/news/5505.documentation new file mode 100644 index 0000000000..7d69fe2f78 --- /dev/null +++ b/packages/volto/news/5505.documentation @@ -0,0 +1 @@ +Clarified where to run Make commands for building documentation. @stevepiercy