Skip to content

Commit

Permalink
docs: project config option: cache_dir
Browse files Browse the repository at this point in the history
  • Loading branch information
stanislaw committed Nov 4, 2024
1 parent 3e83661 commit 2d454a7
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/strictdoc_01_user_guide.sdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 2d454a7

Please sign in to comment.