-
-
Notifications
You must be signed in to change notification settings - Fork 516
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Links between reference notebooks broken when converted to docs #7280
Labels
type: bug
Something isn't correct or isn't working
type: docs
Related to the Panel documentation and examples
Comments
MarcSkovMadsen
added
type: bug
Something isn't correct or isn't working
type: docs
Related to the Panel documentation and examples
need input from Philipp
and removed
need input from Philipp
labels
Sep 15, 2024
MarcSkovMadsen
changed the title
Links between reference notebooks broken
Links between reference notebooks broken when converted to docs
Sep 15, 2024
These are just some examples of the many broken links between reference notebooks. /home/jovyan/repos/private/panel/doc/reference/chat/ChatAreaInput.md:23: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:12: WARNING: 'myst' cross-reference target not found: 'ChatMessage.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:21: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:93: WARNING: 'myst' cross-reference target not found: 'ChatEntry.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:93: WARNING: 'myst' cross-reference target not found: 'ChatEntry.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:372: WARNING: 'myst' cross-reference target not found: 'ChatStep.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:404: WARNING: 'myst' cross-reference target not found: 'ChatStep.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:671: WARNING: 'myst' cross-reference target not found: 'ChatMessage.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:692: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatFeed.md:766: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:18: WARNING: 'myst' cross-reference target not found: 'ChatMessage.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:19: WARNING: 'myst' cross-reference target not found: 'ChatMessage.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:20: WARNING: 'myst' cross-reference target not found: 'ChatMessage.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:22: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:22: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:22: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:324: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatInterface.md:324: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatMessage.md:25: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatMessage.md:27: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatMessage.md:365: WARNING: 'myst' cross-reference target not found: 'ChatInterface.ipynb' [myst.xref_missing]
/home/jovyan/repos/private/panel/doc/reference/chat/ChatStep.md:198: WARNING: 'myst' cross-reference target not found: 'ChatFeed.ipynb' [myst.xref_missing] |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
type: bug
Something isn't correct or isn't working
type: docs
Related to the Panel documentation and examples
In a notebook like ChatMessage.ipynb you have a link to another notebook [
ChatFeed
](ChatFeed.ipynb).This link works when using the notebook as a notebook. But when the notebooks are converted to documentation this no longer works.
See https://holoviz-dev.github.io/panel/reference/chat/ChatMessage.html where the link becomes
#ChatFeed.ipynb
when it should have become something like./ChatFeed.html
.I would suggest we add a script to handle this during the conversion from notebook to markdown.
The text was updated successfully, but these errors were encountered: