include relative-docs should remain in the source folder #1039
Description
What version of myst-parser are you using?
4.0.1-latest
What version dependencies are you using?
accelerate 1.7.0
alabaster 1.0.0
albucore 0.0.24
albumentations 2.0.8
amqp 5.3.1
annotated-types 0.7.0
anyio 4.9.0
asyncpg 0.30.0
babel 2.17.0
billiard 4.2.1
boto3 1.38.36
botocore 1.38.36
celery 5.5.3
certifi 2025.4.26
cffi 1.17.1
chardet 5.2.0
charset-normalizer 3.4.2
click 8.2.1
click-didyoumean 0.3.1
click-plugins 1.1.1
click-repl 0.3.0
coloredlogs 15.0.1
colorlog 6.9.0
contourpy 1.3.2
cryptography 45.0.4
cycler 0.12.1
dill 0.4.0
distro 1.9.0
doclayout-yolo 0.0.4
docutils 0.21.2
fast-langdetect 0.2.5
fastapi 0.115.12
fasttext-predict 0.9.2.4
filelock 3.18.0
flatbuffers 25.2.10
fonttools 4.58.4
fsspec 2025.5.1
ftfy 6.3.1
h11 0.16.0
hf-xet 1.1.4rc2
httpcore 1.0.9
httpx 0.28.1
huggingface-hub 0.33.0
humanfriendly 10.0
idna 3.10
imagesize 1.4.1
jinja2 3.1.6
jiter 0.10.0
jmespath 1.0.1
json-repair 0.46.2
kiwisolver 1.4.8
kombu 5.5.4
loguru 0.7.3
markdown-it-py 3.0.0
markupsafe 3.0.2
matplotlib 3.10.3
mdit-py-plugins 0.4.2
mdurl 0.1.2
mineru 2.0.3
modelscope 1.27.0
mpmath 1.3.0
myst-parser 4.0.1
networkx 3.5
numpy 2.3.0
nvidia-cublas-cu12 12.6.4.1
nvidia-cuda-cupti-cu12 12.6.80
nvidia-cuda-nvrtc-cu12 12.6.77
nvidia-cuda-runtime-cu12 12.6.77
nvidia-cudnn-cu12 9.5.1.17
nvidia-cufft-cu12 11.3.0.4
nvidia-cufile-cu12 1.11.1.6
nvidia-curand-cu12 10.3.7.77
nvidia-cusolver-cu12 11.7.1.2
nvidia-cusparse-cu12 12.5.4.2
nvidia-cusparselt-cu12 0.6.3
nvidia-nccl-cu12 2.26.2
nvidia-nvjitlink-cu12 12.6.85
nvidia-nvtx-cu12 12.6.77
omegaconf 2.4.0.dev3
onnxruntime 1.22.0
openai 1.86.0
opencv-python 4.11.0.86
opencv-python-headless 4.11.0.86
packaging 25.0
pandas 2.3.0
parsimonious 0.10.0
pdfminer-six 20250506
pdftext 0.6.3
pillow 11.2.1
prompt-toolkit 3.0.51
protobuf 6.31.1
psutil 7.0.0
py-cpuinfo 9.0.0
pyclipper 1.3.0.post6
pycparser 2.22
pydantic 2.10.6
pydantic-core 2.27.2
pydantic-settings 2.9.1
pygments 2.19.1
pyparsing 3.2.3
pypdf 5.6.0
pypdfium2 4.30.0
python-dateutil 2.9.0.post0
python-dotenv 1.1.0
python-multipart 0.0.20
pytz 2025.2
pyyaml 6.0.2
rapid-table 1.0.5
redis 5.2.1
regex 2024.11.6
reportlab 4.4.1
requests 2.32.4
robust-downloader 0.0.2
roman-numerals-py 3.1.0
s3transfer 0.13.0
safetensors 0.5.3
scipy 1.16.0rc2
seaborn 0.13.2
setuptools 80.9.0
shapely 2.1.1
simsimd 6.4.9
six 1.17.0
sniffio 1.3.1
snowballstemmer 3.0.1
sphinx 8.2.3
sphinx-js 4.0.0
sphinx-rtd-theme 3.0.2
sphinxcontrib-applehelp 2.0.0
sphinxcontrib-devhelp 2.0.0
sphinxcontrib-htmlhelp 2.1.0
sphinxcontrib-jquery 4.1
sphinxcontrib-jsmath 1.0.1
sphinxcontrib-mermaid 1.0.0
sphinxcontrib-qthelp 2.0.0
sphinxcontrib-serializinghtml 2.0.0
starlette 0.46.2
stringzilla 3.12.5
sympy 1.14.0
thop 0.1.1.post2209072238
tokenizers 0.21.1
torch 2.7.1
torchvision 0.22.1
tqdm 4.67.1
transformers 4.52.4
triton 3.3.1
typing-extensions 4.14.0
typing-inspection 0.4.1
tzdata 2025.2
ultralytics 8.3.155
ultralytics-thop 2.0.14
urllib3 2.4.0
uvicorn 0.34.3
vine 5.1.0
watchdog 6.0.0
wcwidth 0.2.13
What operating system are you using?
Linux
Describe the Bug
I am not sure if it is a bug or a flaw in the documentation but if we consider a file tree like this :
.
├── README.md
├── backend
├── docs
│ ├── Makefile
│ ├── make.bat
│ └── source
│ ├── autodoc
│ │ └── ...
│ ├── conf.py
│ └── index.md
└── human-docs
└── example.md
and in index.md I have
```{include} ../../README.md
:relative-docs: ./human-docs
:relative-images:```
and in README.md I have :
[hello i am a link](./human-docs/example.md)
I have an error of type
/workspaces/repo-name/README.md:33: WARNING: Unknown source document '/workspaces/repo-name/human-docs/example' [myst.xref_missing]
However when I have a tree like this :
.
├── README.md
├── backend
└── docs
├── Makefile
├── make.bat
└── source
├── autodoc
│ └── ...
├── conf.py
├── index.md
└── human-docs
└── example.md
and my index.md :
```{include} ../../README.md
:relative-docs: ./docs
:relative-images:```
and in README.md I have :
[hello i am a link](./docs/source/human-docs/example.md)
it works like a charm.
So I was wandering if it is a bug or a limitation. In the latter maybe some notice in documentation could be nice.
Expected Behavior
Explained above
To Reproduce
Explained above