Skip to content
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

ENH: fix notebook links #4719

Merged
merged 1 commit into from
Nov 2, 2023
Merged

Conversation

Xarthisius
Copy link
Member

@Xarthisius Xarthisius commented Oct 31, 2023

PR Summary

Fix most of orphaned .. notebook directives

Stub .rst with just a label and .. notebook are no longer necessary (won't work anyway). In order to link to in TOC use name of the notebook file directly. In order to link within text use `:doc:<relative/path/to/notebook>`.

.. notebook-cell are still not resolved by this PR, but I haven't figured out how to do them (except for using myst and markdown instead).

@Xarthisius Xarthisius linked an issue Oct 31, 2023 that may be closed by this pull request
@Xarthisius Xarthisius force-pushed the issue_4718 branch 5 times, most recently from b2abcb4 to 1bc0a36 Compare October 31, 2023 19:08
chrishavlin
chrishavlin previously approved these changes Oct 31, 2023
Copy link
Contributor

@chrishavlin chrishavlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome, thanks @Xarthisius !

@chrishavlin
Copy link
Contributor

@matthewturk did you want to look over? or good to merge?

@matthewturk matthewturk merged commit b3cfbf9 into yt-project:main Nov 2, 2023
10 checks passed
@neutrinoceros
Copy link
Member

I should have caught up earlier, but does this need to be backported to yt-4.3.x ?

@neutrinoceros
Copy link
Member

I guess it should, since the bug was affecting stable docs: @meeseeksdev backport to yt-4.3.x

meeseeksmachine pushed a commit to meeseeksmachine/yt that referenced this pull request Nov 3, 2023
@neutrinoceros neutrinoceros added this to the 4.3.1 milestone Nov 3, 2023
neutrinoceros added a commit that referenced this pull request Nov 4, 2023
…9-on-yt-4.3.x

Backport PR #4719 on branch yt-4.3.x (ENH: fix notebook links)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOCS: Notebooks are blank
4 participants