Skip to content

Commit 40741b0

Browse files
authored
chore: add note about external source files not being watched
1 parent 4125cef commit 40741b0

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/setup/extensions/mkdocstrings.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,18 @@ The complete list of options can be found here:
7676

7777
[mkdocstrings documentation]: https://mkdocstrings.github.io/usage/
7878
[mkdocstrings Python handler documentation]: https://mkdocstrings.github.io/python/usage/
79+
80+
!!! warning "Watching source files"
81+
82+
While it is possible to configure search paths that are external to the
83+
docs project (outside of the parent directory containing the
84+
`zensical.toml` file) in the `paths` option of the Python handler, these
85+
external paths will not be watched for change, meaning that modifying
86+
files within them will not trigger a rebuild and reload. The reason is that
87+
the file agent will refuse to watch files that are outside the project folder
88+
for security reasons. We are working on lifting this limitation. You can
89+
follow progress on these backlog items:
90+
91+
- [Proposal: Configuration](https://github.com/zensical/backlog/issues/47)
92+
- [Allow use of `..` in `docs_dir` and `site_dir`](https://github.com/zensical/backlog/issues/56)
93+
- [Symbolic links pointing outside of `docs_dir`](https://github.com/zensical/backlog/issues/55)

0 commit comments

Comments
 (0)