From 2d454a7cacc8a051e989c159f3bbf8edce9a0b9b Mon Sep 17 00:00:00 2001 From: Stanislav Pankevich Date: Mon, 4 Nov 2024 20:17:04 +0100 Subject: [PATCH] docs: project config option: cache_dir --- docs/strictdoc_01_user_guide.sdoc | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/strictdoc_01_user_guide.sdoc b/docs/strictdoc_01_user_guide.sdoc index 0ececd10c..7676569d2 100644 --- a/docs/strictdoc_01_user_guide.sdoc +++ b/docs/strictdoc_01_user_guide.sdoc @@ -2517,6 +2517,23 @@ The ``html_assets_strictdoc_dir`` allows changing the assets folder name: html_assets_strictdoc_dir = "assets" <<< +[SECTION] +TITLE: Path to cache dir + +[TEXT] +STATEMENT: >>> +StrictDoc uses caching when reading and writing artifacts. By default, all caches are written to the system's temporary directory (``$TMPDIR``). + +The ``cache_dir`` option in the configuration file allows specifying a custom directory, such as ``./output/build``. This setting can help make caching artifacts visible alongside documentation artifacts. + +.. code:: toml + + [project] + cache_dir = "./output/cache" +<<< + +[/SECTION] + [/SECTION] [SECTION]